jdk-sandbox: comparison langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java

equal deleted inserted replaced

-:55c73d04e57c
+:476d8d615222
 import static javax.lang.model.element.ElementKind.*;
 import static javax.lang.model.element.Modifier.*;
 import static javax.lang.model.type.TypeKind.*;
 import static com.sun.source.doctree.DocTree.Kind.*;
+import com.sun.source.util.SimpleDocTreeVisitor;
 import static jdk.javadoc.internal.doclets.toolkit.builders.ConstantsSummaryBuilder.MAX_CONSTANT_VALUE_INDEX_LENGTH;
 /**
 * Utilities Class for Doclets.
 TypeMirror superType = te.getSuperclass();
 if (isNoType(superType)) {
 superType = getObjectType();
 }
 TypeElement superClass = asTypeElement(superType);
+// skip "hidden" classes
-while (superClass != null && !isPublic(superClass) && !isLinkable(superClass)) {
+while ((superClass != null && isHidden(superClass))
+|| (superClass != null &&  !isPublic(superClass) && !isLinkable(superClass))) {
 TypeMirror supersuperType = superClass.getSuperclass();
 TypeElement supersuperClass = asTypeElement(supersuperType);
 if (supersuperClass == null
 || supersuperClass.getQualifiedName().equals(superClass.getQualifiedName())) {
 break;
 return propertyName.substring(0, 1).toLowerCase(configuration.getLocale())
 + propertyName.substring(1);
 }
 /**
+* Returns true if the element is included, contains &#64;hidden tag,
+* or if javafx flag is present and element contains &#64;treatAsPrivate
+* tag.
+* @param e the queried element
+* @return true if it exists, false otherwise
+*/
+public boolean isHidden(Element e) {
+// prevent needless tests on elements which are not included
+if (!isIncluded(e)) {
+return false;
+}
+if (configuration.javafx &&
+hasBlockTag(e, DocTree.Kind.UNKNOWN_BLOCK_TAG, "treatAsPrivate")) {
+return true;
+}
+return hasBlockTag(e, DocTree.Kind.HIDDEN);
+}
+/**
 * In case of JavaFX mode on, filters out classes that are private,
-* package private or having the @treatAsPrivate annotation. Those are not
+* package private, these are not documented in JavaFX mode, also
-* documented in JavaFX mode.
+* remove those classes that have &#64;hidden or &#64;treatAsPrivate comment tag.
 *
 * @param classlist a collection of TypeElements
 * @param javafx set to true if in JavaFX mode.
 * @return list of filtered classes.
 */
 boolean javafx) {
 SortedSet<TypeElement> filteredOutClasses =
 new TreeSet<>(makeGeneralPurposeComparator());
 if (!javafx) {
 for (Element te : classlist) {
-filteredOutClasses.add((TypeElement)te);
+if (!isHidden(te)) {
+filteredOutClasses.add((TypeElement)te);
+}
 }
 return filteredOutClasses;
 }
 for (Element e : classlist) {
-if (isPrivate(e) || isPackagePrivate(e)) {
+if (isPrivate(e) || isPackagePrivate(e) || isHidden(e)) {
-continue;
-}
-List<? extends DocTree> aspTags = getBlockTags(e, "treatAsPrivate");
-if (aspTags != null && !aspTags.isEmpty()) {
 continue;
 }
 filteredOutClasses.add((TypeElement)e);
 }
 return filteredOutClasses;
 public List<? extends DocTree> getBlockTags(Element element, String tagName) {
 DocTree.Kind kind = null;
 switch (tagName) {
 case "author":
 case "deprecated":
+case "hidden":
 case "param":
 case "return":
 case "see":
 case "serial":
 case "since":
 break;
 }
 List<? extends DocTree> blockTags = getBlockTags(element, kind);
 List<DocTree> out = new ArrayList<>();
 String tname = tagName.startsWith("@") ? tagName.substring(1) : tagName;
-CommentHelper ch = wksMap.get(element);
+CommentHelper ch = getCommentHelper(element);
 for (DocTree dt : blockTags) {
 if (ch.getTagName(dt).equals(tname)) {
 out.add(dt);
 }
 }
 return out;
+}
+public boolean hasBlockTag(Element element, DocTree.Kind kind) {
+return hasBlockTag(element, kind, null);
+}
+public boolean hasBlockTag(Element element, DocTree.Kind kind, final String tagName) {
+CommentHelper ch = getCommentHelper(element);
+String tname = tagName != null && tagName.startsWith("@")
+? tagName.substring(1)
+: tagName;
+for (DocTree dt : getBlockTags(element, kind)) {
+if (dt.getKind() == kind) {
+if (tname == null || ch.getTagName(dt).equals(tname)) {
+return true;
+}
+}
+}
+return false;
 }
 /**
 * Gets a TreePath for an Element. Note this method is called very
 * frequently, care must be taken to ensure this method is lithe

changeset 37009	476d8d615222
parent 36526	3b41f1c69604
child 37752	4243173b58db