Skip to content

Commit 4fcb888

Browse files
Michael Allmansrowen
authored andcommitted
[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 <[email protected]> Closes apache#14031 from mallman/spark-16353. (cherry picked from commit 7dbffcd) Signed-off-by: Sean Owen <[email protected]>
1 parent c25aa8f commit 4fcb888

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

project/SparkBuild.scala

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -569,8 +569,7 @@ object Unidoc {
569569
ignoreUndocumentedPackages((unidocAllSources in (JavaUnidoc, unidoc)).value)
570570
},
571571

572-
// Javadoc options: create a window title, and group key packages on index page
573-
javacOptions in doc := Seq(
572+
javacOptions in (JavaUnidoc, unidoc) := Seq(
574573
"-windowtitle", "Spark " + version.value.replaceAll("-SNAPSHOT", "") + " JavaDoc",
575574
"-public",
576575
"-group", "Core Java API", packageList("api.java", "api.java.function"),

0 commit comments

Comments
 (0)