forked from apache/incubator-livy
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[LIVY-141][LIVY-175][DOCS] Update javadocs and scaladocs and include …
…in Docs build [LIVY-141](https://issues.apache.org/jira/browse/LIVY-141) [LIVY-175](https://issues.apache.org/jira/browse/LIVY-175) Adding javadocs to Livy: - Add ability to build Livy javadocs - Update current javadoc comments to address build errors and warnings - Add more javadoc comments to fully describe API - Include public API javadocs and scaladocs in Livy Documentation Noted Remaining Issues: - Since only the public javadocs are build with the Livy Docs not all javadoc warnings in other modules have been addressed. - There are still some warnings in the Scala API scaladocs build due to the docs not linking to an external lib for referenced scala lib classes, this does not break the build in any way. - Scaladocs is not supported for Livy as a whole. With the update to Scala 2.11 many scaladoc warnings were upgraded to error and Livy fundamentally can't fix them. Author: Alex Bozarth <[email protected]> Closes apache#38 from ajbozarth/javadoc.
Showing
18 changed files
with
250 additions
and
28 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,6 +14,7 @@ | |
conf/*.conf | ||
conf/*.properties | ||
conf/*.sh | ||
docs/api/ | ||
lib_managed/ | ||
logs/ | ||
src_managed/ | ||
|
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one or more | ||
* contributor license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright ownership. | ||
* The ASF licenses this file to You under the Apache License, Version 2.0 | ||
* (the "License"); you may not use this file except in compliance with | ||
* the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
/** | ||
* Livy programmatic Java API | ||
*/ | ||
package org.apache.livy; |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# Licensed to the Apache Software Foundation (ASF) under one or more | ||
# contributor license agreements. See the NOTICE file distributed with | ||
# this work for additional information regarding copyright ownership. | ||
# The ASF licenses this file to You under the Apache License, Version 2.0 | ||
# (the "License"); you may not use this file except in compliance with | ||
# the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
require 'fileutils' | ||
include FileUtils | ||
|
||
if not (ENV['SKIP_API'] == '1') | ||
# Build Scaladoc for Scala API and Javadoc for Java API | ||
|
||
puts "Moving to scala-api module and building Scala API docs." | ||
cd("../scala-api") | ||
|
||
puts "Running 'mvn scala:doc' from " + pwd + "; this may take a few minutes..." | ||
system("mvn scala:doc") || raise("Scaladoc maven build failed") | ||
|
||
puts "Moving to api module and building Java API docs." | ||
cd("../api") | ||
|
||
puts "Running 'mvn javadoc:javadoc -Ppublic-docs' from " + pwd + "; this may take a few minutes..." | ||
system("mvn javadoc:javadoc -Ppublic-docs") || raise("Javadoc maven build failed") | ||
|
||
puts "Moving back into docs dir." | ||
cd("../docs") | ||
|
||
puts "Removing old docs" | ||
puts `rm -rf api` | ||
|
||
# Copy over the ScalaDoc for the Scala API to api/scala. | ||
# This directory will be copied over to _site when `jekyll` command is run. | ||
source = "../scala-api/target/site/scaladocs" | ||
dest = "api/scala" | ||
|
||
puts "Making directory " + dest | ||
mkdir_p dest | ||
|
||
# From the rubydoc: cp_r('src', 'dest') makes src/dest, but this doesn't. | ||
puts "cp -r " + source + "/. " + dest | ||
cp_r(source + "/.", dest) | ||
|
||
# Copy over the JavaDoc for the Java API to api/java. | ||
source = "../api/target/site/apidocs" | ||
dest = "api/java" | ||
|
||
puts "Making directory " + dest | ||
mkdir_p dest | ||
|
||
puts "cp -r " + source + "/. " + dest | ||
cp_r(source + "/.", dest) | ||
|
||
end |
Oops, something went wrong.