fr.cnes.genius.taglet

Class GNoteTaglet

java.lang.Object

fr.cnes.genius.taglet.GNoteTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class GNoteTaglet
extends Object
implements com.sun.tools.doclets.Taglet

This is a taglet to insert a note in the javadoc of GENIUS project.

Usage in the javadoc of a class:

@genius.note Text.

will give as result:

Note:

Text.

Author:

ffsm

Constructor Summary

Constructors

Constructor and Description
GNoteTaglet()

Method Summary

Modifier and Type	Method and Description
String	getName()
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag()
static void	register(Map<String,GNoteTaglet> tagletMap) Register this Taglet.
String	toString(com.sun.javadoc.Tag tag)
String	toString(com.sun.javadoc.Tag[] tags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GNoteTaglet

public GNoteTaglet()

Method Detail

register

public static void register(Map<String,GNoteTaglet> tagletMap)

Register this Taglet.

Parameters:

tagletMap - the map to register this tag to.

toString

public String toString(com.sun.javadoc.Tag tag)

Specified by:

toString in interface com.sun.tools.doclets.Taglet

toString

public String toString(com.sun.javadoc.Tag[] tags)

Specified by:

toString in interface com.sun.tools.doclets.Taglet

getName

public String getName()

Specified by:

getName in interface com.sun.tools.doclets.Taglet

inField

public boolean inField()

Specified by:

inField in interface com.sun.tools.doclets.Taglet

inConstructor

public boolean inConstructor()

Specified by:

inConstructor in interface com.sun.tools.doclets.Taglet

inMethod

public boolean inMethod()

Specified by:

inMethod in interface com.sun.tools.doclets.Taglet

inOverview

public boolean inOverview()

Specified by:

inOverview in interface com.sun.tools.doclets.Taglet

inPackage

public boolean inPackage()

Specified by:

inPackage in interface com.sun.tools.doclets.Taglet

inType

public boolean inType()

Specified by:

inType in interface com.sun.tools.doclets.Taglet

isInlineTag

public boolean isInlineTag()

Specified by:

isInlineTag in interface com.sun.tools.doclets.Taglet