Closes #95: Display overrides that upgrade visibility.

mozilla-mobile · Nov 30, 2021 · e7438ee · e7438ee
1 parent 93f6516
commit e7438ee
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 8 deletions.
diff --git a/apidoc-plugin/src/main/java/org/mozilla/doclet/ApiDoclet.java b/apidoc-plugin/src/main/java/org/mozilla/doclet/ApiDoclet.java
@@ -265,15 +265,15 @@ private int kindOrder(Element e) {
             default -> 3;
           };
         }
+      };
 
-        private boolean isPublic(Element e) {
-          return e.getModifiers().contains(Modifier.PUBLIC);
-        }
+  private static boolean isPublic(Element e) {
+    return e.getModifiers().contains(Modifier.PUBLIC);
+  }
 
-        private boolean isProtected(Element e) {
-          return e.getModifiers().contains(Modifier.PROTECTED);
-        }
-      };
+  private static boolean isProtected(Element e) {
+    return e.getModifiers().contains(Modifier.PROTECTED);
+  }
 
   private String classNameFragment(TypeElement classDoc) {
     StringBuilder fragment = new StringBuilder(classDoc.getSimpleName().toString());
@@ -375,7 +375,19 @@ private void writeClass(TypeElement typeElement, Writer writer) {
                     || e.getKind() == ElementKind.CONSTRUCTOR
                     || e.getKind().isField())
         // Don't add @Override methods to the API
-        .filter(m -> findSuperMethod(m, writer) == null)
+        .filter(
+            m -> {
+              // Always show the method if the visibility is upgraded
+              // or there's no super method at all
+              Element superMethod = findSuperMethod(m, writer);
+              if (superMethod == null) {
+                return true;
+              }
+              if (!isPublic(superMethod) && !isProtected(superMethod)) {
+                return true;
+              }
+              return isPublic(m) && !isPublic(superMethod);
+            })
         .filter(
             m ->
                 m.getModifiers().stream()

diff --git a/apidoc-plugin/src/test/fake_root/org/mozilla/test/TestClass.java b/apidoc-plugin/src/test/fake_root/org/mozilla/test/TestClass.java
@@ -227,4 +227,18 @@ private TestSortC() {}
     public static final int TEST_INT = 1;
     public static final long TEST_LONG = 2;
     public static final double TEST_DOUBLE = 2.0;
+
+    public static class TestPackageProtected {
+        private TestPackageProtected() {}
+        // This shouldn't appear in the API
+        /* package */ void testPackageProtected();
+    }
+
+    public static class TestOverrideNonVisibleApi extends TestPackageProtected {
+        private TestOverrideNonVisibleApi() {}
+        // This should appear in the API
+        @Override
+        public void testPackageProtected();
+    }
+
 }
diff --git a/apidoc-plugin/src/test/resources/expected-doclet-output.txt b/apidoc-plugin/src/test/resources/expected-doclet-output.txt
@@ -169,6 +169,13 @@ package org.mozilla.test {
     ctor public TestMultipleInterfaceImpl();
   }
 
+  public static class TestClass.TestOverrideNonVisibleApi extends TestClass.TestPackageProtected {
+    method public void testPackageProtected();
+  }
+
+  public static class TestClass.TestPackageProtected {
+  }
+
   public static class TestClass.TestSort {
     method public void testSortA0();
     method public void testSortB0();

diff --git a/apidoc-plugin/src/test/resources/expected-map-output.txt b/apidoc-plugin/src/test/resources/expected-map-output.txt
@@ -169,6 +169,13 @@ org/mozilla/test/TestClass.java:57:5
 org/mozilla/test/TestClass.java:57:19
 
 
+org/mozilla/test/TestClass.java:237:5
+org/mozilla/test/TestClass.java:240:9
+
+
+org/mozilla/test/TestClass.java:231:5
+
+
 org/mozilla/test/TestClass.java:191:5
 org/mozilla/test/TestClass.java:202:9
 org/mozilla/test/TestClass.java:204:9