FreeHEP API
Version current

org.freehep.tools.doclet
Class Standard

java.lang.Object
  extended byorg.freehep.tools.doclet.Standard

public class Standard
extends Object

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

Author:
Atul M Dambalkar, Robert Field
Source Code:
Standard.java

Field Summary
static String BUILD_DATE
          The build date.
 ConfigurationStandard configuration
          The global configuration information for this run.
 
Constructor Summary
Standard()
           
 
Method Summary
protected  String classFileName(com.sun.javadoc.ClassDoc cd)
           
static ConfigurationStandard configuration()
          Create the configuration instance.
protected  void generateClassCycle(com.sun.javadoc.ClassDoc[] arr, com.sun.tools.doclets.ClassTree classtree)
           
protected  void generateClassCycle(com.sun.tools.doclets.ClassTree classtree)
          Instantiate ClassWriter for each Class within the ClassDoc[] passed to it and generate Documentation for that.
protected  void generateClassFiles(com.sun.javadoc.RootDoc root, com.sun.tools.doclets.ClassTree classtree)
           
 boolean generateSerializedFormPage(com.sun.javadoc.RootDoc root)
           
static int optionLength(String option)
          Check for doclet added options here.
protected  void performCopy(String configdestdir, String filename)
           
static boolean start(com.sun.javadoc.RootDoc root)
          The "start" method as required by Javadoc.
protected  void startGeneration(com.sun.javadoc.RootDoc root)
          Start the generation of files.
static boolean validOptions(String[][] options, com.sun.javadoc.DocErrorReporter reporter)
          Check that options have the correct arguments here.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BUILD_DATE

public static final String BUILD_DATE
The build date. Note: For now, we will use a version number instead of a date.


configuration

public ConfigurationStandard configuration
The global configuration information for this run.

Constructor Detail

Standard

public Standard()
Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc root)
                     throws IOException
The "start" method as required by Javadoc.

Parameters:
root -
Returns:
boolean
Throws:
IOException
See Also:
RootDoc

configuration

public static ConfigurationStandard configuration()
Create the configuration instance. Override this method to use a different configuration.


startGeneration

protected void startGeneration(com.sun.javadoc.RootDoc root)
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:
RootDoc

generateClassFiles

protected void generateClassFiles(com.sun.javadoc.RootDoc root,
                                  com.sun.tools.doclets.ClassTree classtree)

classFileName

protected String classFileName(com.sun.javadoc.ClassDoc cd)

generateClassCycle

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


generateClassCycle

protected void generateClassCycle(com.sun.javadoc.ClassDoc[] arr,
                                  com.sun.tools.doclets.ClassTree classtree)

optionLength

public static int optionLength(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.

validOptions

public static boolean validOptions(String[][] options,
                                   com.sun.javadoc.DocErrorReporter reporter)
                            throws IOException
Check that options have the correct arguments here.

This method is not required and will default gracefully (to true) if absent.

Printing option related error messages (using the provided DocErrorReporter) is the responsibility of this method.

Returns:
true if the options are valid.
Throws:
IOException

performCopy

protected void performCopy(String configdestdir,
                           String filename)

generateSerializedFormPage

public boolean generateSerializedFormPage(com.sun.javadoc.RootDoc root)

FreeHEP API
Version current

Copyright © 2000-2004 FreeHEP, All Rights Reserved.