edu.udo.cs.yale.doc
Class AbstractOperatorDocGenerator

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

All Implemented Interfaces:

OperatorDocGenerator

Direct Known Subclasses:

LatexOperatorDocGenerator

public abstract class AbstractOperatorDocGenerator
extends java.lang.Object
implements OperatorDocGenerator

This generator provides useful methods to generate documentation from the Javadoc comments and abstract methods of an operator. Subclasses can be implemented to deliver different target formats like LaTeX or HTML.

Version:

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

Author:

Simon Fischer, Ingo Mierswa

Field Summary

static int	DEPRECATION_INFO
static int	GROUP_NAME
static int	INDEX_ENTRY
static int	INNER_OPERATOR
static int	INPUT_CLASSES_LIST
static int	IO_CLASS
static int	LEARNER_CAPABILITIES
static int	OPERATOR
static int	OPERATOR_DESCRIPTION
static int	OPERATOR_NAME
static int	OUTPUT_CLASSES_LIST
static int	PARAMETER_DESCRIPTION
static int	PARAMETER_ITEM
static int	PARAMETER_LIST
static int	PARAMETER_NAME_OPT
static int	PARAMETER_NAME_REQ
static int	REFERENCE_ENTRY
static int	REFERENCE_SECTION
static int	SHORT_DESCRIPTION
static int	TECHNICAL_INFORMATION
static int	VALUE_DESCRIPTION
static int	VALUE_ITEM
static int	VALUE_LIST
static int	VALUE_NAME
private java.util.Map<java.lang.String,com.sun.tools.doclets.Taglet>	yaleTagletMap

Constructor Summary

AbstractOperatorDocGenerator()

Method Summary

abstract java.lang.String	escape(java.lang.String toEscape) Replace any special characters by an escaped version.
void	generateDoc(Operator op, com.sun.javadoc.RootDoc rootDoc, java.io.PrintWriter out) Generates the documentation for this operator and writes it to the given writer.
abstract java.lang.String	getCloseTag(int tagNo)
abstract java.lang.String	getOpenTag(int tagNo)
abstract java.lang.String	marginIcon(java.lang.String iconName)
private void	printTags(java.io.PrintWriter out, java.lang.String text, int tagNo)
abstract 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 java.lang.Object

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

Methods inherited from interface edu.udo.cs.yale.doc.OperatorDocGenerator

beginGroup, endGroup

Field Detail

OPERATOR

public static final int OPERATOR

See Also:

Constant Field Values

OPERATOR_NAME

public static final int OPERATOR_NAME

See Also:

Constant Field Values

GROUP_NAME

public static final int GROUP_NAME

See Also:

Constant Field Values

PARAMETER_LIST

public static final int PARAMETER_LIST

See Also:

Constant Field Values

PARAMETER_ITEM

public static final int PARAMETER_ITEM

See Also:

Constant Field Values

PARAMETER_NAME_REQ

public static final int PARAMETER_NAME_REQ

See Also:

Constant Field Values

PARAMETER_NAME_OPT

public static final int PARAMETER_NAME_OPT

See Also:

Constant Field Values

PARAMETER_DESCRIPTION

public static final int PARAMETER_DESCRIPTION

See Also:

Constant Field Values

SHORT_DESCRIPTION

public static final int SHORT_DESCRIPTION

See Also:

Constant Field Values

OPERATOR_DESCRIPTION

public static final int OPERATOR_DESCRIPTION

See Also:

Constant Field Values

INPUT_CLASSES_LIST

public static final int INPUT_CLASSES_LIST

See Also:

Constant Field Values

OUTPUT_CLASSES_LIST

public static final int OUTPUT_CLASSES_LIST

See Also:

Constant Field Values

IO_CLASS

public static final int IO_CLASS

See Also:

Constant Field Values

INNER_OPERATOR

public static final int INNER_OPERATOR

See Also:

Constant Field Values

VALUE_LIST

public static final int VALUE_LIST

See Also:

Constant Field Values

VALUE_ITEM

public static final int VALUE_ITEM

See Also:

Constant Field Values

VALUE_NAME

public static final int VALUE_NAME

See Also:

Constant Field Values

VALUE_DESCRIPTION

public static final int VALUE_DESCRIPTION

See Also:

Constant Field Values

INDEX_ENTRY

public static final int INDEX_ENTRY

See Also:

Constant Field Values

REFERENCE_SECTION

public static final int REFERENCE_SECTION

See Also:

Constant Field Values

REFERENCE_ENTRY

public static final int REFERENCE_ENTRY

See Also:

Constant Field Values

TECHNICAL_INFORMATION

public static final int TECHNICAL_INFORMATION

See Also:

Constant Field Values

DEPRECATION_INFO

public static final int DEPRECATION_INFO

See Also:

Constant Field Values

LEARNER_CAPABILITIES

public static final int LEARNER_CAPABILITIES

See Also:

Constant Field Values

yaleTagletMap

private java.util.Map<java.lang.String,com.sun.tools.doclets.Taglet> yaleTagletMap

Constructor Detail

AbstractOperatorDocGenerator

public AbstractOperatorDocGenerator()

Method Detail

transformHTMLJavadocComment

public abstract 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. The class and operator name are only given for debugging purposes.

escape

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

Replace any special characters by an escaped version.

getOpenTag

public abstract java.lang.String getOpenTag(int tagNo)

getCloseTag

public abstract java.lang.String getCloseTag(int tagNo)

marginIcon

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

generateDoc

public void generateDoc(Operator op,
                        com.sun.javadoc.RootDoc rootDoc,
                        java.io.PrintWriter out)

Description copied from interface: OperatorDocGenerator

Generates the documentation for this operator and writes it to the given writer.

Specified by:

generateDoc in interface OperatorDocGenerator

printTags

private void printTags(java.io.PrintWriter out,
                       java.lang.String text,
                       int tagNo)