com.rapidminer.doc
Class ProgramHTMLOperatorDocGenerator

java.lang.Object
  com.rapidminer.doc.ProgramHTMLOperatorDocGenerator

All Implemented Interfaces:

OperatorDocGenerator

public class ProgramHTMLOperatorDocGenerator
extends java.lang.Object
implements OperatorDocGenerator

Formats operator documentation in HTML style.

Author:

Ingo Mierswa

Constructor Summary

ProgramHTMLOperatorDocGenerator()

Method Summary

void	beginGroup(java.lang.String groupName, java.io.PrintWriter out) Does nothing.
void	endGroup(java.lang.String groupName, java.io.PrintWriter out) Does nothing.
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.
java.lang.String	transformHTMLJavadocComment(java.lang.String comment, java.lang.Class clazz, java.lang.String operatorName)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgramHTMLOperatorDocGenerator

public ProgramHTMLOperatorDocGenerator()

Method Detail

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

transformHTMLJavadocComment

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

beginGroup

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

Does nothing.

Specified by:

beginGroup in interface OperatorDocGenerator

endGroup

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

Does nothing.

Specified by:

endGroup in interface OperatorDocGenerator