Packete:
com.c2_tech.doclets
Klassen:
com.c2_tech.doclets.TexDoclet
Hirachie:
java.lang.Object
com.sun.javadoc.Doclet
* This class provides a Java 2, javadoc
Doclet which generates *
* a LaTeX2e document out of the java classes that it is used on. This is *
* convienent for creating printable documentation complete with cross reference *
* information. *
*
*
* Supported HTML tags within comments incude the following *
*
*
* - <dl> *
*
- with the associated <dt><dd></dl> tags *
*
- <p> *
*
- but not align=center...yet *
*
- <br> *
*
- but not clear=xxx *
*
- <table> *
*
- including all the associcated <td><th><tr></td></th></tr> *
*
- <ol> *
*
- ordered lists *
*
- <ul> *
*
- unordered lists *
*
- <font> *
*
- font coloring *
*
- <pre> *
*
- preformatted text *
*
- <code> *
*
- fixed point fonts *
*
- <i> *
*
- italized fonts *
*
- <b> *
*
- bold fonts *
*
*
Felder:
public static java.io.PrintWriter
* Writer for writing to output file *
Methoden:
public static boolean start(com.sun.javadoc.RootDoc)
* Called by the framework to format the entire document *
public static int optionLength(java.lang.String)
* Returns how many arguments would be consumed if option
*
* is a recognized option. *
public static boolean validOptions(java.lang.String[][],com.sun.javadoc.DocErrorReporter)
* Checks the passed options and their arguments for validity. *
com.c2_tech.doclets.TableInfo
Hirachie:
java.lang.Object
* This class provides support for converting HTML tables into LaTeX tables. *
* Some of the things NOT implemented include the following: *
* *
* - valign attributes are not procesed, but align= is. *
*
- rowspan attributes are not processed, but colspan= is. *
*
- the argument to border= in the table tag is not used to control line size *
*
*
*
*
* Here is an example table. *
* *
*
*
* Column 1 Heading | Column two heading | Column three heading *
* |
---|
data | Span two columns *
* |
more data | right | left *
* |
*
* A nested table example *
* |
---|
Column 1 Heading | Column two heading | Column three heading *
* |
---|
data | Span two columns *
* | more data | right | left *
* | *
* |
*
Felder:
Methoden:
public void startCol(java.lang.StringBuffer,java.util.Properties)
* Starts a new column, possibly closing the current column if needed *
public void startHeadCol(java.lang.StringBuffer,java.util.Properties)
* Starts a new Heading column, possibly closing the current column *
* if needed. A Heading column has a Bold Face font directive around *
* it. *
public void endCol(java.lang.StringBuffer)
* Ends the current column. *
public void startRow(java.lang.StringBuffer,java.util.Properties)
* Starts a new row, possibly closing the current row if needed *
public void endRow(java.lang.StringBuffer)
* Ends the current row. *
public void endTable(java.lang.StringBuffer)
* Ends the table, closing the last row as needed *
com.c2_tech.doclets.Package
Hirachie:
java.lang.Object
* This class is used to manage the contents of a Java package. *
* It accepts ClassDoc objects and examines them and groups them *
* according to whether they are classes, interfaces, exceptions *
* or errors. The accumulated Vectors can then be processed to *
* get to all of the elements of the package that fall into each *
* catagory. *
Felder:
protected java.lang.String
* The name of the package this object is for *
protected java.util.Vector
* The classes this package has in it *
protected java.util.Vector
* The interaces this package has in it *
protected java.util.Vector
* The exceptions this package has in it *
protected java.util.Vector
* The errors this package has in it *
Methoden:
public void addElement(com.sun.javadoc.ClassDoc)
* Adds a ClassDoc element to this package. *