/*
* Copyright (C) 2001-2014 RapidMiner GmbH
*/
package com.rapidminer.doc;
import java.util.Map;
import com.sun.javadoc.Tag;
import com.sun.tools.doclets.Taglet;
/**
* 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
*/
public class MathTaglet implements TexTaglet {
private static final String NAME = "rapidminer.math";
public String getName() {
return NAME;
}
public boolean inField() {
return true;
}
public boolean inConstructor() {
return true;
}
public boolean inMethod() {
return true;
}
public boolean inOverview() {
return true;
}
public boolean inPackage() {
return true;
}
public boolean inType() {
return true;
}
public boolean isInlineTag() {
return true;
}
public static void register(Map<String, Taglet> tagletMap) {
MathTaglet tag = new MathTaglet();
Taglet t = tagletMap.get(tag.getName());
if (t != null) {
tagletMap.remove(tag.getName());
}
tagletMap.put(tag.getName(), tag);
}
public String toString(Tag tag) {
return "<i>" + tag.text() + "</i>";
}
public String toString(Tag[] tags) {
return null;
}
public String toTex(Tag tag) {
return "$" + tag.text() + "$";
}
public String toTex(Tag[] tag) {
return null;
}
}