Package com.norconex.commons.lang.javadoc

Class AbstractInlineTaglet

java.lang.Object

com.norconex.commons.lang.javadoc.AbstractInlineTaglet

All Implemented Interfaces:

Taglet

Direct Known Subclasses:

BlockTaglet, HTMLTaglet, JSONTaglet, XMLTaglet

public abstract class AbstractInlineTaglet
extends Object
implements Taglet

Base inline taglet class. Subclasses are by default usable everywhere. Can optionally supply a heading that will appear before the tag content.

 {@mytag #optionaIdForInclusion
   <xml>an example</xml>
 }
 

Since:

2.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Taglet

Taglet.Location

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractInlineTaglet(String name)
protected	AbstractInlineTaglet(String name, Function<TagContent,String> headingProvider)

Method Summary

Modifier and Type	Method	Description
Set<Taglet.Location>	getAllowedLocations()
Function<TagContent,String>	getHeadingProvider()
String	getName()
void	init(DocletEnvironment env, Doclet doclet)
boolean	isInlineTag()
protected abstract String	toString(TagContent tag)
String	toString(List<? extends DocTree> tagTrees, Element element)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractInlineTaglet

protected AbstractInlineTaglet(String name)

AbstractInlineTaglet

protected AbstractInlineTaglet(String name,
                               Function<TagContent,String> headingProvider)

Method Detail

init

public void init(DocletEnvironment env,
                 Doclet doclet)

Specified by:

init in interface Taglet

getName

public String getName()

Specified by:

getName in interface Taglet

getHeadingProvider

public Function<TagContent,String> getHeadingProvider()

isInlineTag

public boolean isInlineTag()

Specified by:

isInlineTag in interface Taglet

getAllowedLocations

public Set<Taglet.Location> getAllowedLocations()

Specified by:

getAllowedLocations in interface Taglet

toString

public String toString(List<? extends DocTree> tagTrees,
                       Element element)

Specified by:

toString in interface Taglet

toString

protected abstract String toString(TagContent tag)