Repository: spark Updated Branches: refs/heads/branch-2.0 4c4f7775c -> 7177e1843
[SPARK-16111][SQL][DOC] Hide SparkOrcNewRecordReader in API docs ## What changes were proposed in this pull request? Currently, Spark Scala/Java API documents shows **org.apache.hadoop.hive.ql.io.orc** package at the top. http://spark.apache.org/docs/2.0.0-preview/api/scala/index.html#org.apache.spark.package http://spark.apache.org/docs/2.0.0-preview/api/java/index.html This PR hides `SparkOrcNewRecordReader` from API docs. ## How was this patch tested? Manual. (`build/sbt unidoc`). The following is the screenshot after this PR. **Scala API doc**  **Java API doc**  Author: Dongjoon Hyun <[email protected]> Closes #13914 from dongjoon-hyun/SPARK-16111. (cherry picked from commit 50fdd866b55cb9b51427095e56b2aafea12a7c23) Signed-off-by: Reynold Xin <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/spark/repo Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/7177e184 Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/7177e184 Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/7177e184 Branch: refs/heads/branch-2.0 Commit: 7177e184368393b1f5ecd246635168ffc10bf91e Parents: 4c4f777 Author: Dongjoon Hyun <[email protected]> Authored: Mon Jun 27 21:58:16 2016 -0700 Committer: Reynold Xin <[email protected]> Committed: Mon Jun 27 21:58:23 2016 -0700 ---------------------------------------------------------------------- project/SparkBuild.scala | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/spark/blob/7177e184/project/SparkBuild.scala ---------------------------------------------------------------------- diff --git a/project/SparkBuild.scala b/project/SparkBuild.scala index 4b44469..4c01ad3 100644 --- a/project/SparkBuild.scala +++ b/project/SparkBuild.scala @@ -720,6 +720,7 @@ object Unidoc { // Skip class names containing $ and some internal packages in Javadocs unidocAllSources in (JavaUnidoc, unidoc) := { ignoreUndocumentedPackages((unidocAllSources in (JavaUnidoc, unidoc)).value) + .map(_.filterNot(_.getCanonicalPath.contains("org/apache/hadoop"))) }, // Javadoc options: create a window title, and group key packages on index page @@ -733,7 +734,8 @@ object Unidoc { unidocSourceBase := s"https://github.com/apache/spark/tree/v${version.value}";, scalacOptions in (ScalaUnidoc, unidoc) ++= Seq( - "-groups" // Group similar methods together based on the @group annotation. + "-groups", // Group similar methods together based on the @group annotation. + "-skip-packages", "org.apache.hadoop" ) ++ ( // Add links to sources when generating Scaladoc for a non-snapshot release if (!isSnapshot.value) { --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
