spark-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sro...@apache.org
Subject spark git commit: [SPARK-16353][BUILD][DOC] Missing javadoc options for java unidoc
Date Mon, 04 Jul 2016 20:16:46 GMT
Repository: spark
Updated Branches:
  refs/heads/branch-1.6 c25aa8fca -> 4fcb88843


[SPARK-16353][BUILD][DOC] Missing javadoc options for java unidoc

Link to Jira issue: https://issues.apache.org/jira/browse/SPARK-16353

## What changes were proposed in this pull request?

The javadoc options for the java unidoc generation are ignored when generating the java unidoc.
For example, the generated `index.html` has the wrong HTML page title. This can be seen at
http://spark.apache.org/docs/latest/api/java/index.html.

I changed the relevant setting scope from `doc` to `(JavaUnidoc, unidoc)`.

## How was this patch tested?

I ran `docs/jekyll build` and verified that the java unidoc `index.html` has the correct HTML
page title.

Author: Michael Allman <michael@videoamp.com>

Closes #14031 from mallman/spark-16353.

(cherry picked from commit 7dbffcdd6dc76b8e8d6a9cd6eeb24323a6b740c3)
Signed-off-by: Sean Owen <sowen@cloudera.com>


Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/4fcb8884
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/4fcb8884
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/4fcb8884

Branch: refs/heads/branch-1.6
Commit: 4fcb88843f5591619f85867e0407a49ed2a9756c
Parents: c25aa8f
Author: Michael Allman <michael@videoamp.com>
Authored: Mon Jul 4 21:16:17 2016 +0100
Committer: Sean Owen <sowen@cloudera.com>
Committed: Mon Jul 4 21:16:41 2016 +0100

----------------------------------------------------------------------
 project/SparkBuild.scala | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/spark/blob/4fcb8884/project/SparkBuild.scala
----------------------------------------------------------------------
diff --git a/project/SparkBuild.scala b/project/SparkBuild.scala
index b1dcaed..afbf93c 100644
--- a/project/SparkBuild.scala
+++ b/project/SparkBuild.scala
@@ -569,8 +569,7 @@ object Unidoc {
       ignoreUndocumentedPackages((unidocAllSources in (JavaUnidoc, unidoc)).value)
     },
 
-    // Javadoc options: create a window title, and group key packages on index page
-    javacOptions in doc := Seq(
+    javacOptions in (JavaUnidoc, unidoc) := Seq(
       "-windowtitle", "Spark " + version.value.replaceAll("-SNAPSHOT", "") + " JavaDoc",
       "-public",
       "-group", "Core Java API", packageList("api.java", "api.java.function"),


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org


Mime
View raw message