edu.udo.cs.yale.doc
Interface OperatorDocGenerator

All Known Implementing Classes:

AbstractOperatorDocGenerator, LatexOperatorDocGenerator

public interface OperatorDocGenerator

Generates the documentation for operators.

Version:

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

Author:

Simon Fischer

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.
void	generateDoc(Operator operator, com.sun.javadoc.RootDoc rootDoc, java.io.PrintWriter out) Generates the documentation for this operator and writes it to the given writer.

Method Detail

generateDoc

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

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

beginGroup

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

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

endGroup

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

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