public abstract class DocInfo extends Object
Constructor and Description |
---|
DocInfo(String rawCommentText,
SourcePositionInfo sp) |
Modifier and Type | Method and Description |
---|---|
void |
addFederatedReference(FederatedSite source) |
Comment |
comment() |
Set<FederatedSite> |
getFederatedReferences() |
String |
getRawCommentText() |
String |
getSince() |
String |
htmlPage()
The path to a web page representing this item.
|
abstract boolean |
isDefinedLocally()
Returns true if the class represented by this object is defined
locally, and thus will be included in local documentation.
|
boolean |
isDocOnly() |
boolean |
isHidden() |
abstract ContainerInfo |
parent() |
SourcePositionInfo |
position() |
abstract String |
relativePath()
Returns the relative path that represents this item on a
documentation source.
|
void |
setFederatedReferences(com.google.clearsilver.jsilver.data.Data data,
String base) |
void |
setSince(String since) |
public DocInfo(String rawCommentText, SourcePositionInfo sp)
public abstract boolean isDefinedLocally()
public abstract String relativePath()
public final String htmlPage()
isDefinedLocally()
returns true.
Otherwise, it is a fully qualified link.public boolean isHidden()
public boolean isDocOnly()
public String getRawCommentText()
public Comment comment()
public SourcePositionInfo position()
public abstract ContainerInfo parent()
public void setSince(String since)
public String getSince()
public final void addFederatedReference(FederatedSite source)
public final Set<FederatedSite> getFederatedReferences()
public final void setFederatedReferences(com.google.clearsilver.jsilver.data.Data data, String base)
Copyright © 2010–2015 MuleSoft, Inc.. All rights reserved.