Skip to content

[SPARK-3359][BUILD][DOCS] Print examples and disable group and tparam tags in javadoc #15939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
HyukjinKwon wants to merge 2 commits into from
Closed

[SPARK-3359][BUILD][DOCS] Print examples and disable group and tparam tags in javadoc #15939

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03f88d4
Print examples in javadoc and disable group and tparam in javadoc
HyukjinKwon Nov 19, 2016
8514ec4
Respect scaladoc precedence between note and example tags
HyukjinKwon Nov 19, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2477,11 +2477,24 @@
<configuration>
<additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
<tags>
<tag>
<name>example</name>
<placement>a</placement>
<head>Example:</head>
</tag>
<tag>
<name>note</name>
<placement>a</placement>
<head>Note:</head>
</tag>
<tag>
<name>group</name>
<placement>X</placement>
</tag>
<tag>
<name>tparam</name>
<placement>X</placement>
</tag>
</tags>
</configuration>
</plugin>
Expand Down
5 changes: 4 additions & 1 deletion project/SparkBuild.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,7 +742,10 @@ object Unidoc {
"-windowtitle", "Spark " + version.value.replaceAll("-SNAPSHOT", "") + " JavaDoc",
"-public",
"-noqualifier", "java.lang",
"-tag", """note:a:Note\:"""
"-tag", """example:a:Example\:""",
"-tag", """note:a:Note\:""",
Copy link
Member Author

@HyukjinKwon HyukjinKwon Nov 19, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This precedence respects scaladoc.

2016-11-20 3 07 35

After this PR, javadoc looks like

2016-11-20 3 10 39

"-tag", "group:X",
"-tag", "tparam:X"
),

// Use GitHub repository for Scaladoc source links
Expand Down