latexlet
Class InlineLaTeXlet

java.lang.Object
  extended by latexlet.LaTeXlet
      extended by latexlet.InlineLaTeXlet
All Implemented Interfaces:
com.sun.tools.doclets.Taglet
Direct Known Subclasses:
InlineBlockLaTeXlet

public class InlineLaTeXlet
extends LaTeXlet

An inline tag, i.e. a tag inline of some javadoc comment text that should normally comprise one line and shall be rendered as an inline image. For general comments on all LaTeXlets see comments in LaTeXlet.

Example:

Some text {@latex.inline $x=y^2 + x_n,\\quad n \\in \\mathcal{L}$} some more text

renders as

Some text $x=y^2 + x_n,\quad n \in \mathcal{L}$ some more text

Author:
Jan Grau

Field Summary
private static String name
           
 
Fields inherited from class latexlet.LaTeXlet
imagePath
 
Constructor Summary
InlineLaTeXlet()
           
 
Method Summary
protected  String getImgInfix()
          Returns the infix of images used for this tag
 String getName()
           
 boolean isInlineTag()
           
protected  boolean isOneLine()
          Returns true if this tag shall be used for LaTeX-expressions of one line used inline of other comment text
static void register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)
          Registers this taglet for the javadoc utility.
 
Methods inherited from class latexlet.LaTeXlet
copy, getBaseForTag, inConstructor, inField, inMethod, inOverview, inPackage, inType, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

private static String name
Constructor Detail

InlineLaTeXlet

public InlineLaTeXlet()
Method Detail

register

public static void register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)
Registers this taglet for the javadoc utility.

Parameters:
tagletMap -

getName

public String getName()

isInlineTag

public boolean isInlineTag()

getImgInfix

protected String getImgInfix()
Description copied from class: LaTeXlet
Returns the infix of images used for this tag

Specified by:
getImgInfix in class LaTeXlet
Returns:
image infix

isOneLine

protected boolean isOneLine()
Description copied from class: LaTeXlet
Returns true if this tag shall be used for LaTeX-expressions of one line used inline of other comment text

Specified by:
isOneLine in class LaTeXlet
Returns:
if this tag is one line statement