diff options
Diffstat (limited to 'src/com/google/doclava/DocInfo.java')
-rw-r--r-- | src/com/google/doclava/DocInfo.java | 27 |
1 files changed, 23 insertions, 4 deletions
diff --git a/src/com/google/doclava/DocInfo.java b/src/com/google/doclava/DocInfo.java index 714beb8..d8a1961 100644 --- a/src/com/google/doclava/DocInfo.java +++ b/src/com/google/doclava/DocInfo.java @@ -32,11 +32,30 @@ public abstract class DocInfo { * The relative path to a web page representing this item. */ public abstract String htmlPage(); - + + /** + * @return true if the element has never been a part of public API + */ public boolean isHidden() { return comment().isHidden(); } + /** + * @return true if the element was once a part of public API, now removed. + */ + public boolean isRemoved() { + return comment().isRemoved(); + } + + /** + * Hidden and removed elements should not be appear in api.txt files, nor + * should they appear in the java doc. + * @return true if the element is either hidden or removed. + */ + public boolean isHiddenOrRemoved() { + return isHidden() || isRemoved(); + } + public boolean isDocOnly() { return comment().isDocOnly(); } @@ -84,7 +103,7 @@ public abstract class DocInfo { public String getSince() { return mSince; } - + public void setDeprecatedSince(String since) { mDeprecatedSince = since; } @@ -100,11 +119,11 @@ public abstract class DocInfo { public final void addFederatedReference(FederatedSite source) { mFederatedReferences.add(source); } - + public final Set<FederatedSite> getFederatedReferences() { return mFederatedReferences; } - + public final void setFederatedReferences(Data data, String base) { int pos = 0; for (FederatedSite source : getFederatedReferences()) { |