org.jdrupes.mdoclet

Class Tags

java.lang.Object

org.jdrupes.mdoclet.Tags

public final class Tags
extends Object

Utility class providing some helpers for working with tags.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEXT_TAG_NAME The name of text tags in the resulting array of Doc.inlineTags().

Method Summary

Modifier and Type	Method and Description
static String	extractInlineTags(String comment, List<String> target) Extracts all inline tags from the given comment and saves them in a target list.
static String	insertInlineTags(String comment, List<String> tags) Re-inserts all inline tags previously extracted using extractInlineTags().
static String	kindOf(String name) Gets the kind of the tag with the given name.

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_TAG_NAME

public static final String TEXT_TAG_NAME

The name of text tags in the resulting array of Doc.inlineTags().

See Also:

Constant Field Values

Method Detail

kindOf

public static String kindOf(String name)

Gets the kind of the tag with the given name. Returns the original name if the tag is unknown.

Parameters:

name - The tag’s name.

Returns:

The kind of the tag.

See Also:

Tag.kind()

extractInlineTags

public static String extractInlineTags(String comment,
                                       List<String> target)

Extracts all inline tags from the given comment and saves them in a target list.

Example

/**
* Foo { @link bar} bar.
* /

becomes

/**
* Foo { @} bar.
* /

and the target list contains the string "{@link bar}".

Parameters:

comment - The comment to extract the inline tags from.

target - The target list to save the extracted inline tags to.

Returns:

The comment with all inline tags replaced with "{@}".

See Also:

insertInlineTags(String, java.util.List)

insertInlineTags

public static String insertInlineTags(String comment,
                                      List<String> tags)

Re-inserts all inline tags previously extracted using extractInlineTags(). All occurrences of "{@}" will be replaced by the string at the corresponding index of the list.

Parameters:

comment - The comment text.

tags - The list of saved inline tags.

Returns:

The String with all inline tags re-inserted.

See Also:

extractInlineTags(String, java.util.List)