Skip to content

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

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
mallman wants to merge 2 commits into from
Closed

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
939e8b5
[SPARK-16353][BUILD][DOC] The javadoc options for the java unidoc
Jul 2, 2016
fcc45c7
Remove seemingly superfluous comment
Jul 4, 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
4 changes: 2 additions & 2 deletions project/SparkBuild.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,8 +723,8 @@ object Unidoc {
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/hadoop")))
},

// Javadoc options: create a window title, and group key packages on index page
javacOptions in doc := Seq(
// Javadoc options: create a window title
Copy link
Contributor Author

@mallman mallman Jul 2, 2016

Choose a reason for hiding this comment

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

BTW, I removed the mention of package groupings because none are defined.

Copy link
Contributor

@jaceklaskowski jaceklaskowski Jul 2, 2016

Choose a reason for hiding this comment

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

Do we really need that line? It's in the git history at the very least and JIRA.

Copy link
Contributor Author

@mallman mallman Jul 3, 2016

Choose a reason for hiding this comment

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

I think we can either change it to just // Javadoc options to clarify that the following javacOptions are in fact for Javadoc, or we can remove the comment entirely.

Copy link
Contributor Author

@mallman mallman Jul 4, 2016

Choose a reason for hiding this comment

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

I removed the comment entirely.

javacOptions in (JavaUnidoc, unidoc) := Seq(
"-windowtitle", "Spark " + version.value.replaceAll("-SNAPSHOT", "") + " JavaDoc",
"-public",
"-noqualifier", "java.lang"
Expand Down