Package org.tquadrat.foundation.javadoc

Class HRefTaglet

java.lang.Object

org.tquadrat.foundation.javadoc.HRefTaglet

All Implemented Interfaces:

Taglet

@ClassVersion(sourceVersion="$Id: HRefTaglet.java 977 2022-01-06 11:41:03Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public final class HRefTaglet
extends Object
implements Taglet

This inline tag inserts a hyperlink to an external URL into the documentation.

Author:

Thomas Thrien - thomas.thrien@tquadrat.org

Version:

$Id: HRefTaglet.java 977 2022-01-06 11:41:03Z tquadrat $

Since:

0.0.5

Nested Class Summary

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

Taglet.Location

Field Summary

Fields

Modifier and Type	Field	Description
private static final Pattern	PATTERN_FULL	The pattern for the tag with both URL and contents.
private static final Pattern	PATTERN_SHORT	The pattern for the tag with only the URL.
static final String	TAGLET_NAME	The name of this taglet: "href".

Constructor Summary

Constructors

Constructor	Description
HRefTaglet()	Creates a new HRefTaglet instance.

Method Summary

Modifier and Type	Method	Description
final Set<Taglet.Location>	getAllowedLocations()
final String	getName()
final boolean	isInlineTag()
final String	toString(List<? extends DocTree> tags, Element element)

Methods inherited from class java.lang.Object

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

Methods inherited from interface jdk.javadoc.doclet.Taglet

init, isBlockTag

Field Details

TAGLET_NAME

public static final String TAGLET_NAME

The name of this taglet: "href".

See Also:

• Constant Field Values

PATTERN_FULL

private static final Pattern PATTERN_FULL

The pattern for the tag with both URL and contents.

PATTERN_SHORT

private static final Pattern PATTERN_SHORT

The pattern for the tag with only the URL.

Constructor Details

HRefTaglet

public HRefTaglet()

Creates a new HRefTaglet instance.

Method Details

getAllowedLocations

public final Set<Taglet.Location> getAllowedLocations()

Specified by:

getAllowedLocations in interface Taglet

getName

public final String getName()

Specified by:

getName in interface Taglet

isInlineTag

public final boolean isInlineTag()

Specified by:

isInlineTag in interface Taglet

toString

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

Specified by:

toString in interface Taglet