satin.tools.doclets.satinapi
Class Standard

java.lang.Object
  |
  +--satin.tools.doclets.satinapi.Standard

public class Standard
extends java.lang.Object

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

Author:

Atul M Dambalkar, Robert Field

Field Summary

static java.lang.String

dateTime

Constructor Summary

Standard()

Method Summary

protected java.lang.String	classFileName(satin.tools.doclets.satinapi.ClassDoc cd)
protected void	generateClassCycle(satin.tools.doclets.satinapi.ClassDoc[] arr, satin.tools.doclets.satinapi.ClassTree classtree, boolean nopackage) Instantiate ClassWriter for each Class within the ClassDoc[] passed to it and generate Documentation for that.
protected void	generateClassFiles(satin.tools.doclets.satinapi.RootDoc root, satin.tools.doclets.satinapi.ClassTree classtree)
static int	optionLength(java.lang.String option) Check for doclet added options here.
protected void	performCopy(java.lang.String configdestdir, java.lang.String filename)
static boolean	start(satin.tools.doclets.satinapi.RootDoc root) The "start" method as required by Javadoc.
protected void	startGeneration(satin.tools.doclets.satinapi.RootDoc root) Start the generation of files.
static boolean	validOptions(java.lang.String[][] options, satin.tools.doclets.satinapi.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

dateTime

public static java.lang.String dateTime

Constructor Detail

Standard

public Standard()

Method Detail

start

public static boolean start(satin.tools.doclets.satinapi.RootDoc root)
                     throws java.io.IOException

The "start" method as required by Javadoc.

Parameters:

Root

Returns:

boolean

startGeneration

protected void startGeneration(satin.tools.doclets.satinapi.RootDoc root)
                        throws satin.tools.doclets.satinapi.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.

generateClassFiles

protected void generateClassFiles(satin.tools.doclets.satinapi.RootDoc root,
                                  satin.tools.doclets.satinapi.ClassTree classtree)
                           throws satin.tools.doclets.satinapi.DocletAbortException

classFileName

protected java.lang.String classFileName(satin.tools.doclets.satinapi.ClassDoc cd)

generateClassCycle

protected void generateClassCycle(satin.tools.doclets.satinapi.ClassDoc[] arr,
                                  satin.tools.doclets.satinapi.ClassTree classtree,
                                  boolean nopackage)
                           throws satin.tools.doclets.satinapi.DocletAbortException

Instantiate ClassWriter for each Class within the ClassDoc[] passed to it and generate Documentation for that.

optionLength

public static int optionLength(java.lang.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(java.lang.String[][] options,
                                   satin.tools.doclets.satinapi.DocErrorReporter reporter)
                            throws java.io.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.

performCopy

protected void performCopy(java.lang.String configdestdir,
                           java.lang.String filename)
                    throws satin.tools.doclets.satinapi.DocletAbortException

Revision History