Remote private classes and methods from output (#159)

Since they are not included in the javadoc anyway, and private classes
inside traits (which are converted to private classes inside
interfaces) are problematic.

Author: raboof

plugin/src/main/scala/com/typesafe/genjavadoc/AST.scala

@@ -11,6 +11,7 @@ trait AST { this: TransformCake ⇒
   trait Templ {
     def name: String
     def sig: String
+    def access: String
   }
 
   case class ClassInfo(
@@ -90,7 +91,7 @@ trait AST { this: TransformCake ⇒
     }
   }
 
-  case class MethodInfo(pattern: String ⇒ String, ret: String, name: String, comment: Seq[String]) extends Templ {
+  case class MethodInfo(access: String, pattern: String ⇒ String, ret: String, name: String, comment: Seq[String]) extends Templ {
     def sig = pattern(s"$ret $name")
   }
   object MethodInfo {
@@ -136,7 +137,7 @@ trait AST { this: TransformCake ⇒
           case Some(deprec) => deprec.appendToComment(commentWithParams)
           case _ => commentWithParams
         }
-      MethodInfo(pattern, ret, name, commentWithParamsAndDeprec)
+      MethodInfo(acc, pattern, ret, name, commentWithParamsAndDeprec)
     }
 
     /**

plugin/src/main/scala/com/typesafe/genjavadoc/BasicTransform.scala

@@ -17,7 +17,7 @@ trait BasicTransform { this: TransformCake ⇒
 
   def newTransformUnit(unit: CompilationUnit): Unit = {
     superTransformUnit(unit)
-    for (c ← flattenObjects(classes.flatMap(liftInnerClassesWithSameName))) {
+    for (c ← flattenObjects(classes.flatMap(liftInnerClassesWithSameName).flatMap(withoutPrivates))) {
       val out = file(c.file)
       try {
         if (c.pckg != "<empty>") out.println(s"package ${c.pckg};")

plugin/src/main/scala/com/typesafe/genjavadoc/Output.scala

@@ -56,7 +56,26 @@ trait Output { this: TransformCake ⇒
   }
 
   /**
-    * Lift nested interfaces and classees with the same name as their parent class to the parent
+    * Private methods and classes are not visible in the javadoc,
+    * so they can be removed wholesale.
+    */
+  def withoutPrivates(c: ClassInfo): Option[ClassInfo] = {
+    def templWithoutPrivates(t: Templ): Option[Templ] = {
+      if (t.access.contains("private")) None
+      else t match {
+        case c: ClassInfo =>
+          Some(c.copy(members = c.members.flatMap(templWithoutPrivates)))
+        case other =>
+          Some(other)
+      }
+    }
+
+    if (c.access.contains("private")) None
+    else Some(c.copy(members = c.members.flatMap(templWithoutPrivates)))
+  }
+
+  /**
+    * Lift nested interfaces with the same name as their parent class to the parent
     * level, as Java does not allow this, mangling their name accordingly
     *
     * Also applied recursively to members
@@ -131,7 +150,7 @@ trait Output { this: TransformCake ⇒
   private def mangleModule(obj: ClassInfo, addMODULE: Boolean, pruneClasses: Boolean): ClassInfo = {
     val moduleInstance =
       if (addMODULE || (obj.module && obj.static))
-        Some(MethodInfo(x ⇒ x, "public static final", s"${obj.name}$$ MODULE$$ = null;",
+        Some(MethodInfo("public", x ⇒ x, "public static final", s"${obj.name}$$ MODULE$$ = null;",
           Seq("/**", " * Static reference to the singleton instance of this Scala object.", " */")))
       else None
 

plugin/src/test/resources/expected_output/basic/akka/actor/Identify.java

@@ -2,7 +2,6 @@
 public final class Identify implements scala.Product, scala.Serializable {
   static public  akka.actor.Identify apply (Object messageId)  { throw new RuntimeException(); }
   static public  scala.Option<java.lang.Object> unapply (akka.actor.Identify x$0)  { throw new RuntimeException(); }
-  static private  java.lang.Object readResolve ()  { throw new RuntimeException(); }
   public  Object messageId ()  { throw new RuntimeException(); }
   // not preceding
   public   Identify (Object messageId)  { throw new RuntimeException(); }

plugin/src/test/resources/expected_output/basic/akka/actor/event/ManagedActorClassification.java

@@ -0,0 +1,3 @@
+package akka.actor.event;
+  public  interface ManagedActorClassification {
+}

plugin/src/test/resources/expected_output/basic/akka/actor/typed/DispatcherSelector.java

@@ -1,5 +1,4 @@
 package akka.actor.typed;
 public abstract class DispatcherSelector extends akka.actor.typed.Props {
-  static private  java.lang.Object readResolve ()  { throw new RuntimeException(); }
   public   DispatcherSelector ()  { throw new RuntimeException(); }
 }

plugin/src/test/resources/expected_output/basic/akka/rk/buh/is/it/A.java

@@ -125,16 +125,6 @@ static public  class EE$ {
      */
     public  void method ()  { throw new RuntimeException(); }
   }
-  /**
-   * object A.NoComment
-   */
-  static private  class NoComment$ {
-    /**
-     * Static reference to the singleton instance of this Scala object.
-     */
-    public static final NoComment$ MODULE$ = null;
-    public   NoComment$ ()  { throw new RuntimeException(); }
-  }
   /**
    * def IAmStatic: Int
    * @return (undocumented)

plugin/src/test/resources/expected_output/basic/akka/rk/buh/is/it/CompressionProtocol.java

@@ -8,7 +8,6 @@ static public  class Events$ {
     public final class HeavyHitterDetected implements akka.rk.buh.is.it.CompressionProtocol.Events.Event, scala.Product, scala.Serializable {
       static public  akka.rk.buh.is.it.CompressionProtocol.Events.HeavyHitterDetected apply (Object key, int id, long count)  { throw new RuntimeException(); }
       static public  scala.Option<scala.Tuple3<java.lang.Object, java.lang.Object, java.lang.Object>> unapply (akka.rk.buh.is.it.CompressionProtocol.Events.HeavyHitterDetected x$0)  { throw new RuntimeException(); }
-      static private  java.lang.Object readResolve ()  { throw new RuntimeException(); }
       public  Object key ()  { throw new RuntimeException(); }
       public  int id ()  { throw new RuntimeException(); }
       public  long count ()  { throw new RuntimeException(); }

plugin/src/test/resources/expected_output/basic/akka/rk/buh/is/it/EWMA$.java

@@ -6,11 +6,6 @@ public  class EWMA$ implements scala.Serializable {
    */
   public static final EWMA$ MODULE$ = null;
   public   EWMA$ () { throw new RuntimeException(); }
-  /**
-   * math.log(2)
-   * @return (undocumented)
-   */
-  private  double LogOf2 () { throw new RuntimeException(); }
   /**
    * Calculate the alpha (decay factor) used in {@link akka.cluster.EWMA}
    * from specified half-life and interval between observations.

plugin/src/test/resources/expected_output/basic/akka/rk/buh/is/it/EWMA.java

@@ -19,15 +19,9 @@
  * <p>
  */
 public final class EWMA implements scala.Product, scala.Serializable {
-  /**
-   * math.log(2)
-   * @return (undocumented)
-   */
-  static private  double LogOf2 () { throw new RuntimeException(); }
   // not preceding
   static public  akka.rk.buh.is.it.EWMA apply (double value, double alpha) { throw new RuntimeException(); }
   static public  scala.Option<scala.Tuple2<java.lang.Object, java.lang.Object>> unapply (akka.rk.buh.is.it.EWMA x$0) { throw new RuntimeException(); }
-  static private  java.lang.Object readResolve () { throw new RuntimeException(); }
   public  double value () { throw new RuntimeException(); }
   public  double alpha () { throw new RuntimeException(); }
   // not preceding