GitHub user HyukjinKwon opened a pull request:
https://github.com/apache/spark/pull/16013
[WIP][SPARK-3359][DOCS] Make javadoc8 working for unidoc/genjavadoc
compatibility in API Java documentation
## What changes were proposed in this pull request?
This PR make `sbt unidoc` complete with Java 8.
This PR roughly includes several fixes as below:
- Fix unrecognisable class and method links in javadoc by changing it from
`[[..]]` to `` `...` ``
```diff
- * A column that will be computed based on the data in a [[DataFrame]].
+ * A column that will be computed based on the data in a `DataFrame`.
```
- Fix an exception annotation to `@note` where the exception class is
unrecognisable in javadoc
```diff
- * @throws NoSuchElementException
+ * @note Throws `NoSuchElementException`
```
- Fix URL links to `<a href="http..."></a>`.
```diff
- * [[http://en.wikipedia.org/wiki/Decision_tree_learning Decision tree]]
model for regression.
+ * <a href="http://en.wikipedia.org/wiki/Decision_tree_learning";>
+ * Decision tree (Wikipedia)</a> model for regression.
```
```diff
- * @see http://en.wikipedia.org/wiki/Receiver_operating_characteristic
+ * @see <a
href="http://en.wikipedia.org/wiki/Receiver_operating_characteristic";>
+ * Receiver operating characteristic (Wikipedia)</a>
```
- Fix < to `<` and > to `>` according to HTML rules.
- Fix `</p>` complaint
## How was this patch tested?
Manually tested by `jekyll build` with Java 7 and 8
```
java version "1.7.0_80"
Java(TM) SE Runtime Environment (build 1.7.0_80-b15)
Java HotSpot(TM) 64-Bit Server VM (build 24.80-b11, mixed mode)
```
```
java version "1.8.0_45"
Java(TM) SE Runtime Environment (build 1.8.0_45-b14)
Java HotSpot(TM) 64-Bit Server VM (build 25.45-b02, mixed mode)
```
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/HyukjinKwon/spark SPARK-3359-errors-more
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/16013.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #16013
----
commit aa2dcb805d1e498a182b5fbdc500b299dd722efb
Author: hyukjinkwon <[email protected]>
Date: 2016-11-25T10:15:48Z
Fix errors (first round)
commit aa5acbb016483c88caad0a57d6481a8fee93e1c3
Author: hyukjinkwon <[email protected]>
Date: 2016-11-25T15:08:06Z
Fix errors (second round)
commit ff17c3a03f681947a6bc2729bd29fd14f07fe20d
Author: hyukjinkwon <[email protected]>
Date: 2016-11-25T15:38:32Z
Fix errors (third round)
commit 1593545d367009c17b3c271e23ae35723af9bd46
Author: hyukjinkwon <[email protected]>
Date: 2016-11-25T15:39:20Z
Fix the linelength style in KafkaUtils.scala
commit 558d5e3982bd7af552fa6f5a1b581355f7b316ff
Author: hyukjinkwon <[email protected]>
Date: 2016-11-25T16:41:44Z
Fix errors (fourth round)
commit 9a9d0cd6f74fa32256ce6edf0832865585242ba2
Author: hyukjinkwon <[email protected]>
Date: 2016-11-25T17:06:12Z
Fix errors (last round)
commit 842a738e8966f70e3b882182a06f2d1e8d257f73
Author: hyukjinkwon <[email protected]>
Date: 2016-11-25T17:19:38Z
Fix more errors
commit 366031768acc4d93a30f23151ce23c00060a322f
Author: hyukjinkwon <[email protected]>
Date: 2016-11-25T17:27:08Z
Make markdown pretty for some links
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
