com.rapidminer.doc
Class DocumentationGenerator

java.lang.Object
  com.rapidminer.doc.DocumentationGenerator

public class DocumentationGenerator
extends java.lang.Object

This is the main class of documentation generation for RapidMiner operators. The target format is LaTeX, therefore a LatexOperatorDocGenerator is used. If no arguments are given to the main method, the LaTeX documentation of the RapidMiner core is generated. If arguments are specified other documentation may be also generated, e.g. for plugin operators.

Author:

Simon Fischer, Ingo Mierswa

Constructor Summary

DocumentationGenerator(OperatorDocGenerator generator)

Method Summary

void	generateAll(java.io.PrintWriter out)
void	generateAll(java.io.PrintWriter out, boolean generateSubgroups)
void	generateGroup(java.io.PrintWriter out, GroupTree group, boolean generateSubgroups)
void	generateOperators(java.io.PrintWriter out, java.util.Collection<OperatorDescription> operators)
static void	main(java.lang.String[] argv) If no arguments are given, the LaTeX documentation of the RapidMiner core is generated.
static boolean	start(com.sun.javadoc.RootDoc rootDoc)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationGenerator

public DocumentationGenerator(OperatorDocGenerator generator)

Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc rootDoc)

generateAll

public void generateAll(java.io.PrintWriter out)

generateAll

public void generateAll(java.io.PrintWriter out,
                        boolean generateSubgroups)

generateGroup

public void generateGroup(java.io.PrintWriter out,
                          GroupTree group,
                          boolean generateSubgroups)

generateOperators

public void generateOperators(java.io.PrintWriter out,
                              java.util.Collection<OperatorDescription> operators)

main

public static void main(java.lang.String[] argv)
                 throws java.io.IOException

If no arguments are given, the LaTeX documentation of the RapidMiner core is generated. Otherwise this documentation generator can be used to generated the documentation of arbitrary RapidMiner operators, e.g. for plugins. In this case the arguments are:
<operators.xml> <sourcedir> <packages> <with_subgroups>

Throws:

java.io.IOException