Add support for @pending annotation.
This behaves the same as @hide, but can be used to annotate API that are
only hidden pending API approval.
Change-Id: I4c0bf46c6d74ed45a8890ecdfd9b14ce234a5c18
diff --git a/tools/droiddoc/src/Comment.java b/tools/droiddoc/src/Comment.java
index f9b9dc2..553cdf2 100644
--- a/tools/droiddoc/src/Comment.java
+++ b/tools/droiddoc/src/Comment.java
@@ -157,7 +157,7 @@
else if (name.equals("@literal")) {
mInlineTagsList.add(new LiteralTagInfo(name, name, text, pos));
}
- else if (name.equals("@hide") || name.equals("@doconly")) {
+ else if (name.equals("@hide") || name.equals("@pending") || name.equals("@doconly")) {
// nothing
}
else if (name.equals("@attr")) {
@@ -307,7 +307,7 @@
mHidden = 0;
return false;
}
- boolean b = mText.indexOf("@hide") >= 0;
+ boolean b = mText.indexOf("@hide") >= 0 || mText.indexOf("@pending") >= 0;
mHidden = b ? 1 : 0;
return b;
}
diff --git a/tools/droiddoc/src/DroidDoc.java b/tools/droiddoc/src/DroidDoc.java
index ef64e36..f48b56c 100644
--- a/tools/droiddoc/src/DroidDoc.java
+++ b/tools/droiddoc/src/DroidDoc.java
@@ -979,10 +979,11 @@
}
/**
- * Returns true if the given element has an @hide annotation.
+ * Returns true if the given element has an @hide or @pending annotation.
*/
private static boolean hasHideAnnotation(Doc doc) {
- return doc.getRawCommentText().indexOf("@hide") != -1;
+ String comment = doc.getRawCommentText();
+ return comment.indexOf("@hide") != -1 || comment.indexOf("@pending") != -1;
}
/**
