| Modifier and Type | Field and Description |
|---|---|
static String |
TEXT_TAG_NAME
The name of text tags in the resulting array of
Doc.inlineTags(). |
| 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. |
public static final String TEXT_TAG_NAME
The name of text tags in the resulting array of
Doc.inlineTags().
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.
name - The tag’s name.Tag.kind()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}".
comment - The comment to extract the inline tags from.target - The target list to save the extracted inline tags to."{@}".insertInlineTags(String, java.util.List)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.
comment - The comment text.tags - The list of saved inline tags.extractInlineTags(String, java.util.List)