Skip to content

[SPARK-16111][SQL][DOC] Hide SparkOrcNewRecordReader in API docs #13914

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

[SPARK-16111][SQL][DOC] Hide SparkOrcNewRecordReader in API docs #13914

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63ab73a
[SPARK-16111][DOC] Hide SparkOrcNewRecordReader in API docs
dongjoon-hyun Jun 26, 2016
181e650
Address comments.
dongjoon-hyun Jun 28, 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: 3 additions & 1 deletion project/SparkBuild.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -720,6 +720,7 @@ object Unidoc {
// Skip class names containing $ and some internal packages in Javadocs
unidocAllSources in (JavaUnidoc, unidoc) := {
ignoreUndocumentedPackages((unidocAllSources in (JavaUnidoc, unidoc)).value)
.map(_.filterNot(_.getCanonicalPath.contains("org/apache/hadoop")))
},

// Javadoc options: create a window title, and group key packages on index page
Expand All @@ -733,7 +734,8 @@ object Unidoc {
unidocSourceBase := s"https://github.com/apache/spark/tree/v${version.value}",

scalacOptions in (ScalaUnidoc, unidoc) ++= Seq(
"-groups" // Group similar methods together based on the @group annotation.
"-groups", // Group similar methods together based on the @group annotation.
"-skip-packages", "org.apache.hadoop"
Copy link
Member Author

@dongjoon-hyun dongjoon-hyun Jun 26, 2016

Choose a reason for hiding this comment

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

For the scala, we can not exclude org.apache.hadoop.hive.ql.io.orc because scalac makes build errors about the missing type in org.apache.hadoop.hive.ql.io.orc. Instead, we need to use -skip-packages option.

) ++ (
// Add links to sources when generating Scaladoc for a non-snapshot release
if (!isSnapshot.value) {
Expand Down