[SPARK-16353][BUILD][DOC] Missing javadoc options for java unidoc #14031
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
generation are not honored. The scope of the relevant javacOptions key should be `(JavaUnidoc, unidoc)` not `doc`
| .map(_.filterNot(_.getCanonicalPath.contains("org/apache/hadoop"))) | ||
| }, | ||
|
|
||
| // Javadoc options: create a window title, and group key packages on index page |
Contributor
Author
There was a problem hiding this comment.
BTW, I removed the mention of package groupings because none are defined.
Member
|
Jenkins add to whitelist |
Member
|
Jenkins test this please |
Member
|
LGTM |
|
Test build #61687 has finished for PR 14031 at commit
|
|
Test build #61728 has finished for PR 14031 at commit
|
asfgit
pushed a commit
that referenced
this pull request
Jul 4, 2016
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 #14031 from mallman/spark-16353. (cherry picked from commit 7dbffcd) Signed-off-by: Sean Owen <[email protected]>
asfgit
pushed a commit
that referenced
this pull request
Jul 4, 2016
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 #14031 from mallman/spark-16353. (cherry picked from commit 7dbffcd) Signed-off-by: Sean Owen <[email protected]>
Member
|
Merged to master/2.0/1.6 |
Contributor
Author
|
Thank you. |
zzcclp
pushed a commit
to zzcclp/spark
that referenced
this pull request
Jul 5, 2016
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]> (cherry picked from commit 4fcb888)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.htmlhas 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
docto(JavaUnidoc, unidoc).How was this patch tested?
I ran
docs/jekyll buildand verified that the java unidocindex.htmlhas the correct HTML page title.