Skip to content
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

Jump to bottom

[SPARK-3359][DOCS] Make javadoc8 working for unidoc/genjavadoc compatibility in Java API documentation #16013

Closed
wants to merge 17 commits into from
Closed

[SPARK-3359][DOCS] Make javadoc8 working for unidoc/genjavadoc compatibility in Java API documentation #16013

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
aa2dcb8
Fix errors (first round)
HyukjinKwon Nov 25, 2016
aa5acbb
Fix errors (second round)
HyukjinKwon Nov 25, 2016
ff17c3a
Fix errors (third round)
HyukjinKwon Nov 25, 2016
1593545
Fix the linelength style in KafkaUtils.scala
HyukjinKwon Nov 25, 2016
558d5e3
Fix errors (fourth round)
HyukjinKwon Nov 25, 2016
9a9d0cd
Fix errors (last round)
HyukjinKwon Nov 25, 2016
842a738
Fix more errors
HyukjinKwon Nov 25, 2016
3660317
Make markdown pretty for some links
HyukjinKwon Nov 25, 2016
22bfb68
Keep original style without new indentations
HyukjinKwon Nov 25, 2016
73fcd35
Use throws annotation
HyukjinKwon Nov 26, 2016
246bef3
Print < and > properly within this PR
HyukjinKwon Nov 26, 2016
a2a2011
Fix other existing ones for < and >
HyukjinKwon Nov 26, 2016
ee3b96b
Make sql parameter pretty in JdbcRDD
HyukjinKwon Nov 26, 2016
65d8f79
Fix nits and markdown
HyukjinKwon Nov 26, 2016
2defa60
Revert the change not in the API documentation
HyukjinKwon Nov 26, 2016
d2c6e86
Address comments (rebased for reviewing)
HyukjinKwon Nov 28, 2016
7d44dc5
Fix a typo and remove chekced exception annotation
HyukjinKwon Nov 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
6 changes: 2 additions & 4 deletions core/src/main/scala/org/apache/spark/SparkContext.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2061,9 +2061,8 @@ class SparkContext(config: SparkConf) extends Logging {
* Cancel a given job if it's scheduled or running.
*
* @param jobId the job ID to cancel
* @throws InterruptedException if the cancel message cannot be sent
* @note Throws `InterruptedException` if the cancel message cannot be sent
Copy link
Member

Choose a reason for hiding this comment

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

Hm, InterruptedException is in java.lang so I am surprised it isn't found. Does it help if you write @throws java.lang.InterruptedException? that's better if it works

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure, I will try!

Copy link
Member Author

Choose a reason for hiding this comment

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

Hm.. interesting. I haven't looked into this deeper but it seems it fails anyway.

[error] .../java/org/apache/spark/SparkContext.java:1150: error: exception not thrown: java.lang.InterruptedException
[error]    * @throws java.lang.InterruptedException if the cancel message cannot be sent
[error]              ^

Copy link
Member

Choose a reason for hiding this comment

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

Hm, so it's just complaining that it's documented as a checked exception but can't be thrown according to the byte code. It has a point there, but I am also kind of surprised it's an error. OK Leave it the way you have it as it seems like it's the only way that works.

*/
@throws(classOf[InterruptedException])
def cancelJob(jobId: Int) {
dagScheduler.cancelJob(jobId)
}
Expand All @@ -2072,9 +2071,8 @@ class SparkContext(config: SparkConf) extends Logging {
* Cancel a given stage and all jobs associated with it.
*
* @param stageId the stage ID to cancel
* @throws InterruptedException if the cancel message cannot be sent
* @note Throws `InterruptedException` if the cancel message cannot be sent
*/
@throws(classOf[InterruptedException])
def cancelStage(stageId: Int) {
dagScheduler.cancelStage(stageId)
}
Expand Down
2 changes: 1 addition & 1 deletion mllib/src/main/scala/org/apache/spark/mllib/tree/configuration/BoostingStrategy.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import org.apache.spark.mllib.tree.loss.{LogLoss, Loss, SquaredError}
* If the current loss on the validation set is greater than 0.01, the diff
* of validation error is compared to relative tolerance which is
* validationTol * (current loss on the validation set).
* If the current loss on the validation set is less than or euqal to 0.01,
* If the current loss on the validation set is less than or equal to 0.01,
* the diff of validation error is compared to absolute tolerance which is
* validationTol * 0.01.
* Ignored when
Expand Down