Skip to content

Commit cc100ab

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 <michael@videoamp.com> Closes #14031 from mallman/spark-16353. (cherry picked from commit 7dbffcd) Signed-off-by: Sean Owen <sowen@cloudera.com>
1 parent d5683a7 commit cc100ab

1 file changed

Lines changed: 1 addition & 2 deletions

File tree

project/SparkBuild.scala

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -723,8 +723,7 @@ object Unidoc {
723723
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/hadoop")))
724724
},
725725

726-
// Javadoc options: create a window title, and group key packages on index page
727-
javacOptions in doc := Seq(
726+
javacOptions in (JavaUnidoc, unidoc) := Seq(
728727
"-windowtitle", "Spark " + version.value.replaceAll("-SNAPSHOT", "") + " JavaDoc",
729728
"-public",
730729
"-noqualifier", "java.lang"

0 commit comments

Comments
 (0)