net.sf.latextaglet.internal
Class LaTeXTaglet

java.lang.Object
  net.sf.latextaglet.internal.LaTeXTaglet

All Implemented Interfaces:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet

Direct Known Subclasses:

LaTeXBlockEquationTaglet, LaTeXEquationTaglet, LaTeXInlineTaglet

public abstract class LaTeXTaglet
extends java.lang.Object
implements com.sun.tools.doclets.internal.toolkit.taglets.Taglet

Abstract taglet class für writing formulae The LaTeX code can use commands of the (La)TeX math mode with the additional packages

amsfonts,latexsym,amsmath,amsthm,amscd,amssymb,eucal,exscale,dsfont,icomma,bm

Requirements: (La)TeX Installation, ImageMagick, ghostscript

 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

Constructor Summary

LaTeXTaglet()

Method Summary

boolean	inConstructor() Will return true since @latex can be used in constructor documentation.
boolean	inField() Will return true since @latex can be used in field documentation.
boolean	inMethod() Will return true since @latex can be used in method documentation.
boolean	inOverview() Will return true since @latex can be used in method documentation.
boolean	inPackage() Will return true since @latex can be used in package documentation.
boolean	inType() Will return true since @latex can be used in type documentation (classes or interfaces).
boolean	isInlineTag() Will return false since @latex is not an inline tag.
abstract java.lang.String	toString(com.sun.javadoc.Tag[] tags, com.sun.tools.doclets.internal.toolkit.Configuration conf)
abstract 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

Methods inherited from interface com.sun.tools.doclets.internal.toolkit.taglets.Taglet

getName, getTagletOutput, getTagletOutput

Constructor Detail

LaTeXTaglet

public LaTeXTaglet()

Method Detail

inField

public boolean inField()

Will return true since @latex can be used in field documentation.

Specified by:

inField in interface com.sun.tools.doclets.internal.toolkit.taglets.Taglet

Returns:

true since @latex can be used in field documentation and false otherwise.

inConstructor

public boolean inConstructor()

Will return true since @latex can be used in constructor documentation.

Specified by:

inConstructor in interface com.sun.tools.doclets.internal.toolkit.taglets.Taglet

Returns:

true since @latex can be used in constructor documentation and false otherwise.

inMethod

public boolean inMethod()

Will return true since @latex can be used in method documentation.

Specified by:

inMethod in interface com.sun.tools.doclets.internal.toolkit.taglets.Taglet

Returns:

true since @latex can be used in method documentation and false otherwise.

inOverview

public boolean inOverview()

Will return true since @latex can be used in method documentation.

Specified by:

inOverview in interface com.sun.tools.doclets.internal.toolkit.taglets.Taglet

Returns:

true since @latex can be used in overview documentation and false otherwise.

inPackage

public boolean inPackage()

Will return true since @latex can be used in package documentation.

Specified by:

inPackage in interface com.sun.tools.doclets.internal.toolkit.taglets.Taglet

Returns:

true since @latex can be used in package documentation and false otherwise.

inType

public boolean inType()

Will return true since @latex can be used in type documentation (classes or interfaces).

Specified by:

inType in interface com.sun.tools.doclets.internal.toolkit.taglets.Taglet

Returns:

true since @latex can be used in type documentation and false otherwise.

isInlineTag

public boolean isInlineTag()

Will return false since @latex is not an inline tag.

Specified by:

isInlineTag in interface com.sun.tools.doclets.internal.toolkit.taglets.Taglet

Returns:

false since @latex is not an inline tag.

toString

public abstract java.lang.String toString(com.sun.javadoc.Tag tag,
                                          com.sun.tools.doclets.internal.toolkit.Configuration conf)

Parameters:

tag -

conf -

Returns:

String that is printed in the corresponding html file

toString

public abstract java.lang.String toString(com.sun.javadoc.Tag[] tags,
                                          com.sun.tools.doclets.internal.toolkit.Configuration conf)

Parameters:

tags -

conf -

Returns:

String that is printed in the corresponding html file