Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS

Class sun.tools.javadoc.doclets.Standard

sun.tools.javadoc.doclets.Standard

public class Standard
The class with "start" method, calls individual Writers.


Field Summary
static Configuration  configuration
           
 

Constructor Summary
 Standard()
           
 

Method Summary
sun.tools.javadoc.doclets.String  classFileName(sun.tools.javadoc.doclets.ClassDoc cd)
           
static Configuration  configuration()
          Return the configuration instance.
void  generateClassCycle(sun.tools.javadoc.doclets.ClassDoc[] arr, ClassTree classtree)
          Instantiate ClassWriter for each Class within the ClassDoc[] passed to it and generate Documentation for that.
void  generateClassFiles(sun.tools.javadoc.doclets.Root root, ClassTree classtree)
           
static int  optionLength(sun.tools.javadoc.doclets.String option)
          Check for doclet added options here.
static boolean  start(sun.tools.javadoc.doclets.Root root)
          The "start" method as required by Javadoc.
void  startGeneration(sun.tools.javadoc.doclets.Root root)
          Start the generation of files.
void  startGenerationOneOne(sun.tools.javadoc.doclets.Root root)
          Start the generation of files.
 

Field Detail

configuration

public static Configuration configuration
Constructor Detail

Standard

public Standard()
Method Detail

start

public static boolean start(sun.tools.javadoc.doclets.Root root) throws sun.tools.javadoc.doclets.IOException
          The "start" method as required by Javadoc.
Parameters:
Root -
Returns:
boolean
See Also:
sun.tools.javadoc.Root

configuration

public static Configuration configuration()
          Return the configuration instance. Create if it doesn't exist. Override this method to use a different configuration.

startGeneration

protected void startGeneration(sun.tools.javadoc.doclets.Root root) throws DocletAbortException
          Start the generation of files. Call generate methods in the individual writers, which will in turn genrate the documentation files. Call the TreeWriter generation first to ensure the Class Hierarchy is built first and then can be used in the later generation. For new format.
See Also:
sun.tools.javadoc.Root

startGenerationOneOne

protected void startGenerationOneOne(sun.tools.javadoc.doclets.Root root) throws DocletAbortException
          Start the generation of files. Call generate methods in the individual writers, which will in turn genrate the documentation files. Call the TreeWriter generation first to ensure the Class Hierarchy is built first and then can be used in the later generation. For old 1.1 format.
See Also:
sun.tools.javadoc.Root

generateClassFiles

protected void generateClassFiles(sun.tools.javadoc.doclets.Root root,
                                  ClassTree classtree) throws DocletAbortException

classFileName

protected sun.tools.javadoc.doclets.String classFileName(sun.tools.javadoc.doclets.ClassDoc cd)

generateClassCycle

protected void generateClassCycle(sun.tools.javadoc.doclets.ClassDoc[] arr,
                                  ClassTree classtree) throws DocletAbortException
          Instantiate ClassWriter for each Class within the ClassDoc[] passed to it and generate Documentation for that.

optionLength

public static int optionLength(sun.tools.javadoc.doclets.String option)
          Check for doclet added options here.
Returns:
number of arguments to option. Zero return means option not known. Negative value means error occurred.

Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS