diff options
author | hyukjinkwon <gurwls223@gmail.com> | 2016-11-29 09:41:32 +0000 |
---|---|---|
committer | Sean Owen <sowen@cloudera.com> | 2016-11-29 09:41:32 +0000 |
commit | f830bb9170f6b853565d9dd30ca7418b93a54fe3 (patch) | |
tree | fc0d6d04f1e3759745401f3a2cbfa337d76c40a9 /external/flume/src | |
parent | 7d5cb3af7621ad6eb85d1ba7f585c3921ca0a242 (diff) | |
download | spark-f830bb9170f6b853565d9dd30ca7418b93a54fe3.tar.gz spark-f830bb9170f6b853565d9dd30ca7418b93a54fe3.tar.bz2 spark-f830bb9170f6b853565d9dd30ca7418b93a54fe3.zip |
[SPARK-3359][DOCS] Make javadoc8 working for unidoc/genjavadoc compatibility in Java API 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 throws annotations so that they are recognisable in javadoc
- 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 > to
- `greater than`/`greater than or equal to` or `less than`/`less than or equal to` where applicable.
- Wrap it with `{{{...}}}` to print them in javadoc or use `{code ...}` or `{literal ..}`. Please refer https://github.com/apache/spark/pull/16013#discussion_r89665558
- 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)
```
Author: hyukjinkwon <gurwls223@gmail.com>
Closes #16013 from HyukjinKwon/SPARK-3359-errors-more.
Diffstat (limited to 'external/flume/src')
-rw-r--r-- | external/flume/src/main/scala/org/apache/spark/streaming/flume/FlumePollingInputDStream.scala | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/external/flume/src/main/scala/org/apache/spark/streaming/flume/FlumePollingInputDStream.scala b/external/flume/src/main/scala/org/apache/spark/streaming/flume/FlumePollingInputDStream.scala index 54565840fa..d84e289272 100644 --- a/external/flume/src/main/scala/org/apache/spark/streaming/flume/FlumePollingInputDStream.scala +++ b/external/flume/src/main/scala/org/apache/spark/streaming/flume/FlumePollingInputDStream.scala @@ -36,7 +36,7 @@ import org.apache.spark.streaming.flume.sink._ import org.apache.spark.streaming.receiver.Receiver /** - * A [[ReceiverInputDStream]] that can be used to read data from several Flume agents running + * A `ReceiverInputDStream` that can be used to read data from several Flume agents running * [[org.apache.spark.streaming.flume.sink.SparkSink]]s. * @param _ssc Streaming context that will execute this input stream * @param addresses List of addresses at which SparkSinks are listening |