com.rapidminer.doc
Class MathTaglet

java.lang.Object
  com.rapidminer.doc.MathTaglet

All Implemented Interfaces:

TexTaglet, com.sun.tools.doclets.Taglet

public class MathTaglet
extends java.lang.Object
implements TexTaglet

A taglet with name "@rapidminer.math" can be used in the Javadoc comments of an operator to produce mathematical code. Example: "@rapidminer.math 1/(n+1)". This will include a LaTeX math environment to you documentation.

Author:

Simon Fischer, Ingo Mierswa

Constructor Summary

MathTaglet()

Method Summary

java.lang.String	getName()
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag()
static void	register(java.util.Map<java.lang.String,com.sun.tools.doclets.Taglet> tagletMap)
java.lang.String	toString(com.sun.javadoc.Tag tag)
java.lang.String	toString(com.sun.javadoc.Tag[] tags)
java.lang.String	toTex(com.sun.javadoc.Tag tag)
java.lang.String	toTex(com.sun.javadoc.Tag[] tag)

Methods inherited from class java.lang.Object

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

Constructor Detail

MathTaglet

public MathTaglet()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface com.sun.tools.doclets.Taglet

inField

public boolean inField()

Specified by:

inField in interface com.sun.tools.doclets.Taglet

inConstructor

public boolean inConstructor()

Specified by:

inConstructor in interface com.sun.tools.doclets.Taglet

inMethod

public boolean inMethod()

Specified by:

inMethod in interface com.sun.tools.doclets.Taglet

inOverview

public boolean inOverview()

Specified by:

inOverview in interface com.sun.tools.doclets.Taglet

inPackage

public boolean inPackage()

Specified by:

inPackage in interface com.sun.tools.doclets.Taglet

inType

public boolean inType()

Specified by:

inType in interface com.sun.tools.doclets.Taglet

isInlineTag

public boolean isInlineTag()

Specified by:

isInlineTag in interface com.sun.tools.doclets.Taglet

register

public static void register(java.util.Map<java.lang.String,com.sun.tools.doclets.Taglet> tagletMap)

toString

public java.lang.String toString(com.sun.javadoc.Tag tag)

Specified by:

toString in interface com.sun.tools.doclets.Taglet

toString

public java.lang.String toString(com.sun.javadoc.Tag[] tags)

Specified by:

toString in interface com.sun.tools.doclets.Taglet

toTex

public java.lang.String toTex(com.sun.javadoc.Tag tag)

Specified by:

toTex in interface TexTaglet

toTex

public java.lang.String toTex(com.sun.javadoc.Tag[] tag)

Specified by:

toTex in interface TexTaglet