com.go.beandoc
Class BeanDoc

com.go.beandoc.BeanDoc

public class BeanDoc

The BeanDoc doclet generates "BeanInfo.java" files for each of the classes and interfaces to be documented. The Java file is created using an accompanying Tea template.

BeanDoc makes use of the teadoc sub-package in order to wrap the classes of the doclet API to provide a Tea-friendly JavaBean interface for each class.

Version:
8 , 8/23/00
Author:
Mark Masse

Constructor Summary
BeanDoc(com.sun.javadoc.RootDoc root)
          Creates a new BeanDoc with the specified RootDoc object.
 
Method Summary
protected  boolean accept(ClassDoc classDoc)
          Returns true if the ClassDoc should be documented
 RootDoc getRootDoc()
          Returns the RootDoc object
protected  void init(com.sun.javadoc.RootDoc root, java.lang.String dest, java.lang.String templateClassName)
          Initializes the BeanDoc instance.
static int optionLength(java.lang.String option)
           
 void printError(java.lang.String msg)
          Prints an error message
 void printNotice(java.lang.String msg)
          Prints an notice message
 void printWarning(java.lang.String msg)
          Prints an warning message
 void start()
          Generates BeanInfo.java files for each of the ClassDocs in the RootDoc.
static boolean start(com.sun.javadoc.RootDoc root)
          Starts the BeanDoc doclet.
 

Constructor Detail

BeanDoc

public BeanDoc(com.sun.javadoc.RootDoc root)
        throws java.lang.Exception
Creates a new BeanDoc with the specified RootDoc object.
Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc root)
Starts the BeanDoc doclet. Called by the javadoc tool.

optionLength

public static int optionLength(java.lang.String option)

start

public void start()
Generates BeanInfo.java files for each of the ClassDocs in the RootDoc.

getRootDoc

public RootDoc getRootDoc()
Returns the RootDoc object

printError

public void printError(java.lang.String msg)
Prints an error message

printWarning

public void printWarning(java.lang.String msg)
Prints an warning message

printNotice

public void printNotice(java.lang.String msg)
Prints an notice message

init

protected void init(com.sun.javadoc.RootDoc root,
                    java.lang.String dest,
                    java.lang.String templateClassName)
             throws java.lang.Exception
Initializes the BeanDoc instance.

accept

protected boolean accept(ClassDoc classDoc)
Returns true if the ClassDoc should be documented