LaTeXlet - a LaTeX taglet for Javadoc

LaTeXlet is a taglet that allows to use LaTeX within Javadoc comments.
LaTeXlet is free software: you can redistribute it and/or modify under the terms of the GNU General Public License version 3 or (at your option) any later version as published by the Free Software Foundation.
LaTeXlet 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 General Public License for more details.

The tags defined by LaTeXlet that can be used in javadoc comments are

Examples for each of the tags can be found in the API documentation of BlockLaTeXlet, InlineLaTeXlet, and InlineBlockLaTeXlet.

Within any of these tags, LaTeX code can be used as usual with the only restriction that all back-slashes must be escaped, i.e. \ becomes \\ and a linebreak \\ becomes \\\\.
Additionally, you can use three special tags inside a LaTeXlet tag:

You must provide the following arguments to the javadoc command in order to use LaTeXlet:
-taglet latexlet.InlineBlockLaTeXlet -taglet latexlet.BlockLaTeXlet -taglet latexlet.InlineLaTeXlet -tagletpath path/to/the/jar/LaTeXlet.jar


LaTeXlet has been tested under Mac OS X (Leopard and later), Linux, and Windows.


The latest version of LaTeXlet has been tested using Java 6 and 7. However, if you experience any problems with this version under Java 6, you might want to try version 1.2 of LaTeXlet. You find this version here.
Earlier version of LaTeXlet

Related Software