Single-line ScalaDoc plus deprecated annotation would trigger a bug #85
Comments
|
Same here, but that is not single line: This was with Scala 2.12.0-RC2 |
asfgit
pushed a commit
to apache/spark
that referenced
this issue
Nov 29, 2016
…g for backticks
## What changes were proposed in this pull request?
Currently, single line comment does not mark down backticks to `<code>..</code>` but prints as they are (`` `..` ``). For example, the line below:
```scala
/** Return an RDD with the pairs from `this` whose keys are not in `other`. */
```
So, we could work around this as below:
```scala
/**
* Return an RDD with the pairs from `this` whose keys are not in `other`.
*/
```
- javadoc
- **Before**
- **After**
- scaladoc (this one looks fine either way)
- **Before**
- **After**
I suspect this is related with SPARK-16153 and genjavadoc issue in ` lightbend/genjavadoc#85`.
## How was this patch tested?
I found them via
```
grep -r "\/\*\*.*\`" . | grep .scala
````
and then checked if each is in the public API documentation with manually built docs (`jekyll build`) with Java 7.
Author: hyukjinkwon <[email protected]>
Closes #16050 from HyukjinKwon/javadoc-markdown.
asfgit
pushed a commit
to apache/spark
that referenced
this issue
Nov 29, 2016
…g for backticks
## What changes were proposed in this pull request?
Currently, single line comment does not mark down backticks to `<code>..</code>` but prints as they are (`` `..` ``). For example, the line below:
```scala
/** Return an RDD with the pairs from `this` whose keys are not in `other`. */
```
So, we could work around this as below:
```scala
/**
* Return an RDD with the pairs from `this` whose keys are not in `other`.
*/
```
- javadoc
- **Before**
- **After**
- scaladoc (this one looks fine either way)
- **Before**
- **After**
I suspect this is related with SPARK-16153 and genjavadoc issue in ` lightbend/genjavadoc#85`.
## How was this patch tested?
I found them via
```
grep -r "\/\*\*.*\`" . | grep .scala
````
and then checked if each is in the public API documentation with manually built docs (`jekyll build`) with Java 7.
Author: hyukjinkwon <[email protected]>
Closes #16050 from HyukjinKwon/javadoc-markdown.
(cherry picked from commit 1a87009)
Signed-off-by: Sean Owen <[email protected]>
robert3005
pushed a commit
to palantir/spark
that referenced
this issue
Dec 2, 2016
…g for backticks
## What changes were proposed in this pull request?
Currently, single line comment does not mark down backticks to `<code>..</code>` but prints as they are (`` `..` ``). For example, the line below:
```scala
/** Return an RDD with the pairs from `this` whose keys are not in `other`. */
```
So, we could work around this as below:
```scala
/**
* Return an RDD with the pairs from `this` whose keys are not in `other`.
*/
```
- javadoc
- **Before**
- **After**
- scaladoc (this one looks fine either way)
- **Before**
- **After**
I suspect this is related with SPARK-16153 and genjavadoc issue in ` lightbend/genjavadoc#85`.
## How was this patch tested?
I found them via
```
grep -r "\/\*\*.*\`" . | grep .scala
````
and then checked if each is in the public API documentation with manually built docs (`jekyll build`) with Java 7.
Author: hyukjinkwon <[email protected]>
Closes apache#16050 from HyukjinKwon/javadoc-markdown.
uzadude
pushed a commit
to uzadude/spark
that referenced
this issue
Jan 27, 2017
…g for backticks
## What changes were proposed in this pull request?
Currently, single line comment does not mark down backticks to `<code>..</code>` but prints as they are (`` `..` ``). For example, the line below:
```scala
/** Return an RDD with the pairs from `this` whose keys are not in `other`. */
```
So, we could work around this as below:
```scala
/**
* Return an RDD with the pairs from `this` whose keys are not in `other`.
*/
```
- javadoc
- **Before**
- **After**
- scaladoc (this one looks fine either way)
- **Before**
- **After**
I suspect this is related with SPARK-16153 and genjavadoc issue in ` lightbend/genjavadoc#85`.
## How was this patch tested?
I found them via
```
grep -r "\/\*\*.*\`" . | grep .scala
````
and then checked if each is in the public API documentation with manually built docs (`jekyll build`) with Java 7.
Author: hyukjinkwon <[email protected]>
Closes apache#16050 from HyukjinKwon/javadoc-markdown.
jrudolph
added a commit
to jrudolph/genjavadoc
that referenced
this issue
Sep 18, 2017
This somewhat fixes lightbend#85 so that genjavadoc does at least not fail. However, like in the case for deprecated lazy vals with preexisting scaladoc, the preexisting comment might be lost under some Scala versions. The reason seems to be that starting from Scala 2.12 positions are reported in a way that puts the original position on the private `$lzycompute` method instead of on the accessor. To fix that additional considerations are necessary to somehow reconcile position information from the lzycompute with the actual accessor so that existing and generated scaladoc can be merged.
jrudolph
added a commit
to jrudolph/akka
that referenced
this issue
Sep 19, 2017
To avoid genjavadoc issue lightbend/genjavadoc#85.
jrudolph
added a commit
to jrudolph/akka
that referenced
this issue
Sep 19, 2017
To avoid genjavadoc issue lightbend/genjavadoc#85.
raboof
pushed a commit
to akka/akka
that referenced
this issue
Sep 19, 2017
To avoid genjavadoc issue lightbend/genjavadoc#85.
lucianenache
pushed a commit
to lucianenache/akka
that referenced
this issue
Nov 6, 2017
…3655) To avoid genjavadoc issue lightbend/genjavadoc#85.
lucianenache
pushed a commit
to lucianenache/akka
that referenced
this issue
Nov 9, 2017
…3655) To avoid genjavadoc issue lightbend/genjavadoc#85.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We recently deprecated setLabelCol in ChiSqSelectorModel in Spark (apache/spark#13823):
This unfortunately hit a genjavadoc bug and broken doc generation. This is the generated Java code:
Switching to multiline is a workaround (apache/spark#13855). It would be nice to fix this bug in genjavadoc.
The text was updated successfully, but these errors were encountered: