doc.doclets

Class PtDoclet

java.lang.Object

doc.doclets.PtDoclet

public class PtDoclet
extends java.lang.Object

Generate PtDoc output. See ptolemy/vergil/basic/DocML_1.dtd for the dtd.

If javadoc is called with -d directoryName, then documentation will be generated in directoryName. If the KEPLER property is set, then for a class named foo.bar.Baz, the generated file is named Baz.doc.xml. If the KEPLER property is not set, then the generated file is named foo/bar/Baz.xml.

This doclet writes the names of all the classes for which documentation was generated in a file called allNamedObjs.txt

Since:

Ptolemy II 5.2

Version:

$Id$

Author:

Christopher Brooks, Edward A. Lee, Contributors: Nandita Mangal, Ian Brown

Constructor Summary

Constructors

Constructor and Description
PtDoclet()

Method Summary

Modifier and Type	Method and Description
static int	optionLength(java.lang.String option) Given a command line option, return the number of command line arguments needed by that option.
static boolean	start(com.sun.javadoc.RootDoc root) Process the java files and generate PtDoc XML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PtDoclet

public PtDoclet()

Method Detail

optionLength

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

Given a command line option, return the number of command line arguments needed by that option.

Parameters:

option - The command line option

Returns:

If the option is "-d", return 2; otherwise, return 0.

start

public static boolean start(com.sun.javadoc.RootDoc root)
                     throws java.io.IOException,
                            java.lang.ClassNotFoundException

Process the java files and generate PtDoc XML. Only classes that extend ptolemy.actor.TypedAtomicActor are processed, all other classes are ignored.

Parameters:

root - The root of the java doc tree.

Returns:

Always return true;

Throws:

java.io.IOException - If there is a problem writing the documentation.

java.lang.ClassNotFoundException - If there is a problem finding the class of one of the fields.