public class LinkReference extends Object
Modifier and Type | Field and Description |
---|---|
ClassInfo |
classInfo
The
ClassInfo if any. |
boolean |
good
Set to true if everything is a-ok
|
String |
href
The link.
|
boolean |
isLocal
True if the link is for a page in this documentation.
|
String |
kind
The kind of this tag, if we have a new suggestion after parsing.
|
String |
label
The user visible text.
|
MemberInfo |
memberInfo
The
MemberInfo if any. |
PackageInfo |
packageInfo
The
PackageInfo if any. |
String |
referencedMemberName
The name of the referenced member PackageInfo} if any.
|
String |
text
The original text.
|
Modifier and Type | Method and Description |
---|---|
boolean |
checkLevel() |
static LinkReference |
parse(String text,
ContainerInfo base,
SourcePositionInfo pos,
boolean printOnErrors)
Parse and resolve a link string.
|
public String text
public String kind
public String label
public String href
public boolean isLocal
public PackageInfo packageInfo
PackageInfo
if any.public MemberInfo memberInfo
MemberInfo
if any.public String referencedMemberName
public boolean good
public static LinkReference parse(String text, ContainerInfo base, SourcePositionInfo pos, boolean printOnErrors)
text
- the original textbase
- the class or whatever that this link is onpos
- the original position in the source documentpublic boolean checkLevel()
Copyright © 2010–2015 MuleSoft, Inc.. All rights reserved.