edu.udo.cs.yale.doc
Class LatexOperatorDocGenerator

java.lang.Object
  edu.udo.cs.yale.doc.AbstractOperatorDocGenerator
      edu.udo.cs.yale.doc.LatexOperatorDocGenerator

All Implemented Interfaces:

OperatorDocGenerator

public class LatexOperatorDocGenerator
extends AbstractOperatorDocGenerator

Formats operator documentation in LaTeX style.

Version:

$Id: LatexOperatorDocGenerator.java,v 2.35 2006/08/03 16:20:47 ingomierswa Exp $

Author:

Simon Fischer, Ingo Mierswa

To do:

Lookup class when link is found and decide which tag to use (op, ioobj, ...)

Field Summary

static java.lang.String[][]

TAGS

Fields inherited from class edu.udo.cs.yale.doc.AbstractOperatorDocGenerator

DEPRECATION_INFO, GROUP_NAME, INDEX_ENTRY, INNER_OPERATOR, INPUT_CLASSES_LIST, IO_CLASS, LEARNER_CAPABILITIES, OPERATOR, OPERATOR_DESCRIPTION, OPERATOR_NAME, OUTPUT_CLASSES_LIST, PARAMETER_DESCRIPTION, PARAMETER_ITEM, PARAMETER_LIST, PARAMETER_NAME_OPT, PARAMETER_NAME_REQ, REFERENCE_ENTRY, REFERENCE_SECTION, SHORT_DESCRIPTION, TECHNICAL_INFORMATION, VALUE_DESCRIPTION, VALUE_ITEM, VALUE_LIST, VALUE_NAME

Constructor Summary

LatexOperatorDocGenerator()

Method Summary

void	beginGroup(java.lang.String groupName, java.io.PrintWriter out) Generates the header for the group with the given name.
void	endGroup(java.lang.String groupName, java.io.PrintWriter out) Generates the footer for the group with the given name.
java.lang.String	escape(java.lang.String toEscape) Replace any special characters by an escaped version.
java.lang.String	getCloseTag(int tagNo)
java.lang.String	getOpenTag(int tagNo)
java.lang.String	marginIcon(java.lang.String iconName)
java.lang.String	transformHTMLJavadocComment(java.lang.String comment, java.lang.Class clazz, java.lang.String operatorName) Transform the HTML-comment to the respective output language.

Methods inherited from class edu.udo.cs.yale.doc.AbstractOperatorDocGenerator

generateDoc

Methods inherited from class java.lang.Object

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

Field Detail

TAGS

public static final java.lang.String[][] TAGS

Constructor Detail

LatexOperatorDocGenerator

public LatexOperatorDocGenerator()

Method Detail

getOpenTag

public java.lang.String getOpenTag(int tagNo)

Specified by:

getOpenTag in class AbstractOperatorDocGenerator

getCloseTag

public java.lang.String getCloseTag(int tagNo)

Specified by:

getCloseTag in class AbstractOperatorDocGenerator

marginIcon

public java.lang.String marginIcon(java.lang.String iconName)

Specified by:

marginIcon in class AbstractOperatorDocGenerator

escape

public java.lang.String escape(java.lang.String toEscape)

Description copied from class: AbstractOperatorDocGenerator

Replace any special characters by an escaped version.

Specified by:

escape in class AbstractOperatorDocGenerator

beginGroup

public void beginGroup(java.lang.String groupName,
                       java.io.PrintWriter out)

Description copied from interface: OperatorDocGenerator

Generates the header for the group with the given name. The name might be null.

endGroup

public void endGroup(java.lang.String groupName,
                     java.io.PrintWriter out)

Description copied from interface: OperatorDocGenerator

Generates the footer for the group with the given name. The name might be null.

transformHTMLJavadocComment

public java.lang.String transformHTMLJavadocComment(java.lang.String comment,
                                                    java.lang.Class clazz,
                                                    java.lang.String operatorName)

Description copied from class: AbstractOperatorDocGenerator

Transform the HTML-comment to the respective output language. The class and operator name are only given for debugging purposes.

Specified by:

transformHTMLJavadocComment in class AbstractOperatorDocGenerator