Java Doc for DocGenerator.java in  » Development » Java-Plugin-Framework » org » java » plugin » tools » docgen » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Development » Java Plugin Framework » org.java.plugin.tools.docgen   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.java.plugin.tools.docgen.DocGenerator DocGenerator final public class DocGenerator (Code) Tool class to generate documentation for plug-ins using JXP templates. version:    $Id$ Inner Class :final public static class Tool Inner Class :final static class IdentityComparator implements Comparator<Identity> Constructor Summary public   DocGenerator(PluginRegistry aRegistry, PathResolver aPathResolver)      Constructs generator configured to use pre-defined set of templates. public   DocGenerator(PluginRegistry aRegistry, PathResolver aPathResolver, String templatesPath, String templatesEncoding)      Constructs generator configured to use custom templates available in the classpath. public   DocGenerator(PluginRegistry aRegistry, PathResolver aPathResolver, File templatesFolder, String templatesEncoding)      Constructs generator configured to use custom templates located somewhere in the local file system. Method Summary public  void generate(File destDir)      Generates documentation for all registered plug-ins. public  String getDocumentationOverview()      public  String getOutputEncoding()      public  String getStylesheet()      public  void setDocumentationOverview(String aDocumentationOverview)      public  void setOutputEncoding(String encoding)      public  void setStylesheet(String aStylesheet)      Constructor Detail DocGenerator public DocGenerator(PluginRegistry aRegistry, PathResolver aPathResolver) throws Exception(Code) Constructs generator configured to use pre-defined set of templates. Parameters:   aRegistry - plug-ins registry Parameters:   aPathResolver - path resolver throws:   Exception - if an error has occurred DocGenerator public DocGenerator(PluginRegistry aRegistry, PathResolver aPathResolver, String templatesPath, String templatesEncoding) throws Exception(Code) Constructs generator configured to use custom templates available in the classpath. Parameters:   aRegistry - plug-ins registry Parameters:   aPathResolver - path resolver Parameters:   templatesPath - path to templates (should be available in classpath) Parameters:   templatesEncoding - templates characters encoding, if null, systemdefault will be used throws:   Exception - if an error has occurred DocGenerator public DocGenerator(PluginRegistry aRegistry, PathResolver aPathResolver, File templatesFolder, String templatesEncoding) throws Exception(Code) Constructs generator configured to use custom templates located somewhere in the local file system. Parameters:   aRegistry - plug-ins registry Parameters:   aPathResolver - path resolver Parameters:   templatesFolder - folder with templates Parameters:   templatesEncoding - templates characters encoding, if null, systemdefault will be used throws:   Exception - if an error has occurred Method Detail generate public void generate(File destDir) throws Exception(Code) Generates documentation for all registered plug-ins. Parameters:   destDir - target folder throws:   Exception - if an error has occurred getDocumentationOverview public String getDocumentationOverview()(Code) documentation overview HTML content getOutputEncoding public String getOutputEncoding()(Code) output files encoding name getStylesheet public String getStylesheet()(Code) CSS style sheet content setDocumentationOverview public void setDocumentationOverview(String aDocumentationOverview)(Code) Parameters:   aDocumentationOverview - documentation overview HTML content setOutputEncoding public void setOutputEncoding(String encoding)(Code) Parameters:   encoding - output files encoding name (default is UTF-8) setStylesheet public void setStylesheet(String aStylesheet)(Code) Parameters:   aStylesheet - CSS style sheet content Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)