Typically they are found at the end of Javadoc comments.
Examples:
@see AnotherClass
@since v0.0.1
@author Jim O'Java
| Modifier and Type | Class and Description |
|---|---|
| public static enum | JavadocBlockTag.
The type of tag: it could either correspond to a known tag (param, return, etc.) or represent an unknown tag. |
| Modifier and Type | Field and Description |
|---|---|
| private JavadocDescription | |
| private Optional | |
| private String | |
| private JavadocBlockTag. |
| Access | Constructor and Description |
|---|---|
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public static JavadocBlockTag | |
| public boolean | equals(Object
the reference object with which to compare. o)Overrides java. |
| public JavadocDescription | |
| public Optional | |
| public String | |
| public JavadocBlockTag. | |
| public int | |
| public String | |
| public String |
| content | back to summary |
|---|---|
| private JavadocDescription content | |
| name | back to summary |
|---|---|
| private Optional<String> name | |
| tagName | back to summary |
|---|---|
| private String tagName | |
| type | back to summary |
|---|---|
| private JavadocBlockTag. | |
| JavadocBlockTag | back to summary |
|---|---|
| public JavadocBlockTag(JavadocBlockTag. | |
| JavadocBlockTag | back to summary |
|---|---|
| public JavadocBlockTag(String tagName, String content) | |
| createParamBlockTag | back to summary |
|---|---|
| public static JavadocBlockTag createParamBlockTag(String paramName, String content) | |
| equals | back to summary |
|---|---|
| public boolean equals(Object o) Overrides java. Doc from java. Indicates whether some other object is "equal to" this one.
The
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. | |
| getContent | back to summary |
|---|---|
| public JavadocDescription getContent() | |
| getName | back to summary |
|---|---|
| public Optional | |
| getTagName | back to summary |
|---|---|
| public String getTagName() | |
| getType | back to summary |
|---|---|
| public JavadocBlockTag. | |
| hashCode | back to summary |
|---|---|
| public int hashCode() Overrides java. Doc from java. Returns a hash code value for this object. This method is
supported for the benefit of hash tables such as those provided by
The general contract of
| |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. Doc from java. Returns a string representation of the object. | |
| toText | back to summary |
|---|---|
| public String toText() | |
| Modifier and Type | Field and Description |
|---|---|
| public static final JavadocBlockTag. | |
| public static final JavadocBlockTag. | |
| public static final JavadocBlockTag. | |
| private String | |
| public static final JavadocBlockTag. | |
| public static final JavadocBlockTag. | |
| public static final JavadocBlockTag. | |
| public static final JavadocBlockTag. | |
| public static final JavadocBlockTag. | |
| public static final JavadocBlockTag. | |
| public static final JavadocBlockTag. | |
| public static final JavadocBlockTag. | |
| public static final JavadocBlockTag. | |
| public static final JavadocBlockTag. |
| Access | Constructor and Description |
|---|---|
| private |
| Modifier and Type | Method and Description |
|---|---|
| pack-priv static JavadocBlockTag. | |
| pack-priv boolean | |
| public static JavadocBlockTag. | |
| public static JavadocBlockTag. |
| AUTHOR | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| DEPRECATED | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| EXCEPTION | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| keyword | back to summary |
|---|---|
| private String keyword | |
| PARAM | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| RETURN | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| SEE | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| SERIAL | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| SERIAL_DATA | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| SERIAL_FIELD | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| SINCE | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| THROWS | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| UNKNOWN | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| VERSION | back to summary |
|---|---|
| public static final JavadocBlockTag. | |
| Type | back to summary |
|---|---|
| private Type() | |
| fromName | back to summary |
|---|---|
| pack-priv static JavadocBlockTag. | |
| hasName | back to summary |
|---|---|
| pack-priv boolean hasName() | |
| valueOf | back to summary |
|---|---|
| public static JavadocBlockTag. | |
| values | back to summary |
|---|---|
| public static JavadocBlockTag. | |