latexlet
Class BlockLaTeXlet

java.lang.Object
  extended by latexlet.LaTeXlet
      extended by latexlet.BlockLaTeXlet
All Implemented Interfaces:
com.sun.tools.doclets.Taglet

public class BlockLaTeXlet
extends LaTeXlet

A block tag, i.e. a tag at the tag section of a javadoc comment (after the first @ in a javadoc comment). For general comments on all LaTeXlets see comments in LaTeXlet.

Example:

@latex.block %preamble{\\usepackage{amssymb}}
             \\begin{eqnarray}
               \\sum_{n=1}^{N} p_n &=& \\Sigma,\\quad p_n \\in \\mathbb{R}\\\\
               \\frac{1}{x} &=& y^2\\nonumber
             \\end{eqnarray}

renders as seen in LaTeX section below.

Author:
Jan Grau

LaTeX:

%preamble{\usepackage{amssymb}}\begin{eqnarray}\sum_{n=1}^{N} p_n &=& \Sigma,\quad p_n \in \mathbb{R}\\


Field Summary
private static String name
           
 
Fields inherited from class latexlet.LaTeXlet
imagePath
 
Constructor Summary
BlockLaTeXlet()
           
 
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

BlockLaTeXlet

public BlockLaTeXlet()
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