com.sdl.dxa.javadoc

Class PublicApiTaglet

java.lang.Object

com.sdl.dxa.javadoc.PublicApiTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

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

Taglet that supports a custom tag dxa.publicApi and adds information to Javadoc about the DXA public API. Supports multiple similar tags and all code elements.

See Also:

How to use custom taglet with Maven

Constructor Summary

Constructors

Constructor and Description
PublicApiTaglet()

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,com.sun.tools.doclets.Taglet> tagletMap)
String	toString(com.sun.javadoc.Tag tag) Given the Tag representation of this custom tag, return its string representation.
String	toString(com.sun.javadoc.Tag[] tags) Given an array of Tags representing this custom tag, return its string representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicApiTaglet

public PublicApiTaglet()

Method Detail

register

public static void register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)

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

getName

public String getName()

Specified by:

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

toString

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

Given the Tag representation of this custom tag, return its string representation.

Specified by:

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

Parameters:

tag - the Tag representation of this custom tag.

toString

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

Given an array of Tags representing this custom tag, return its string representation.

Specified by:

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

Parameters:

tags - the array of Tags representing of this custom tag.