Uploaded image for project: 'Spark'
  1. Spark
  2. SPARK-7992

Hide private classes/objects in in generated Java API doc

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.4.0
    • Fix Version/s: 2.0.0
    • Component/s: Build, Documentation
    • Labels:
      None
    • Target Version/s:

      Description

      After SPARK-5610, we found that private classes/objects still show up in the generated Java API doc, e.g., under `org.apache.spark.api.r` we can see

      BaseRRDD
      PairwiseRRDD
      RRDD
      SpecialLengths
      StringRRDD
      

      We should update genjavadoc to hide those private classes/methods. The best approach is to find a good mapping from Scala private to Java, and merge it into the main genjavadoc repo. A WIP PR is at https://github.com/typesafehub/genjavadoc/pull/47.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                jodersky Jakob Odersky
                Reporter:
                mengxr Xiangrui Meng
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: