com.webcohesion.enunciate.javac.javadoc

Class JavaDocLink

java.lang.Object

com.webcohesion.enunciate.javac.javadoc.JavaDocLink

public class JavaDocLink
extends Object

Models the @link inline tag in javadoc.

See Also:

@link documentation

Method Summary

Modifier and Type	Method and Description
String	getClassName() Returns the class name or an empty string if link is a within the current class (starts with `#`).
String	getLabel() Returns label specified in this tag or null if omitted.
String	getMemberName() Returns the member name from the link or an empty string.
boolean	hasLabel() Answers if this link has an alternative label.
static JavaDocLink	parse(String text) Parses the specified text as a link.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getClassName

public String getClassName()

Returns the class name or an empty string if link is a within the current class (starts with `#`).

getMemberName

public String getMemberName()

Returns the member name from the link or an empty string.

hasLabel

public boolean hasLabel()

Answers if this link has an alternative label.

getLabel

public String getLabel()

Returns label specified in this tag or null if omitted.

toString

public String toString()

Overrides:

toString in class Object

parse

public static JavaDocLink parse(String text)

Parses the specified text as a link.