net.sf.latextaglet
Class LaTeXInlineTaglet
java.lang.Object
net.sf.latextaglet.internal.LaTeXTaglet
net.sf.latextaglet.LaTeXInlineTaglet
- All Implemented Interfaces:
- com.sun.tools.doclets.internal.toolkit.taglets.Taglet
public class LaTeXInlineTaglet
- extends LaTeXTaglet
Taglet class for inline style formulae
Usage: {@latex.$ \sum_i x_i}
Examples: and
Copyright (C) Stephan Dlugosz, 2007. All Rights Reserved.
LaTeXTaglet is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
LaTeXTaglet is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser Public License for more details.
You should have received a copy of the GNU Lesser Public License
along with LaTeXTaglet; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- Author:
- Stephan Dlugosz
Method Summary |
java.lang.String |
getName()
Return the name of this custom tag. |
com.sun.tools.doclets.internal.toolkit.taglets.TagletOutput |
getTagletOutput(com.sun.javadoc.Doc arg0,
com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter arg1)
|
com.sun.tools.doclets.internal.toolkit.taglets.TagletOutput |
getTagletOutput(com.sun.javadoc.Tag arg0,
com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter arg1)
|
static void |
register(java.util.Map tagletMap)
Register this Taglet. |
java.lang.String |
toString(com.sun.javadoc.Tag[] tags,
com.sun.tools.doclets.internal.toolkit.Configuration conf)
|
java.lang.String |
toString(com.sun.javadoc.Tag tag,
com.sun.tools.doclets.internal.toolkit.Configuration conf)
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
LaTeXInlineTaglet
public LaTeXInlineTaglet()
getName
public java.lang.String getName()
- Return the name of this custom tag.
- Returns:
- Name
register
public static void register(java.util.Map tagletMap)
- Register this Taglet.
- Parameters:
tagletMap
- the map to register this tag to.
toString
public java.lang.String toString(com.sun.javadoc.Tag tag,
com.sun.tools.doclets.internal.toolkit.Configuration conf)
- Specified by:
toString
in class LaTeXTaglet
- Parameters:
tag
- conf
-
- Returns:
- String that is printed in the corresponding html file
toString
public java.lang.String toString(com.sun.javadoc.Tag[] tags,
com.sun.tools.doclets.internal.toolkit.Configuration conf)
- Specified by:
toString
in class LaTeXTaglet
- Parameters:
tags
- conf
-
- Returns:
- String that is printed in the corresponding html file
getTagletOutput
public com.sun.tools.doclets.internal.toolkit.taglets.TagletOutput getTagletOutput(com.sun.javadoc.Tag arg0,
com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter arg1)
throws java.lang.IllegalArgumentException
- Throws:
java.lang.IllegalArgumentException
getTagletOutput
public com.sun.tools.doclets.internal.toolkit.taglets.TagletOutput getTagletOutput(com.sun.javadoc.Doc arg0,
com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter arg1)
throws java.lang.IllegalArgumentException
- Throws:
java.lang.IllegalArgumentException