Package edu.udo.cs.yale.doc

The documentation generator of YALE.

See:
          Description

Interface Summary
OperatorDocGenerator Generates the documentation for operators.
TexTaglet Creates the LaTeX code from a html taglet.
 

Class Summary
AbstractOperatorDocGenerator This generator provides useful methods to generate documentation from the Javadoc comments and abstract methods of an operator.
CiteTaglet A taglet with name "@yale.cite" can be used in the Javadoc comments of an operator to produce a reference to literature.
CommentStripper Delivers the class comments of the Javadoc comments of an operator class.
DocumentationGenerator This is the main class of documentation generation for Yale operators.
LatexOperatorDocGenerator Formats operator documentation in LaTeX style.
MathTaglet A taglet with name "@yale.math" can be used in the Javadoc comments of an operator to produce mathematical code.
ReferenceTaglet A taglet with name "@yale.reference" can be used in the Javadoc comments of an operator to produce a reference to literature including the bibtex entry.
RefTaglet A taglet with name "@yale.ref" can be used in the Javadoc comments of an operator to produce textual references.
XMLExampleTaglet A taglet with name "@yale.xmlinput" can be used in the Javadoc comments of an operator to include an XML file into the documentation.
 

Package edu.udo.cs.yale.doc Description

The documentation generator of YALE. This generator can also be used to automatically construct the documentation of your own operators or plugins.



Copyright © 2001-2006