genjavadoc
genjavadoc copied to clipboard
javadoc 8 errors on some translated scaladoc elements
I'm trying to get javadoc 8 to be happy with the output of genjavadoc for Apache Spark. A lot works; I've noticed a few issues though. javadoc 8 treats a lot of stuff as errors now.
For example, @example and @note and @group tags are valid scaladoc, but not javadoc. These get passed through as-is to generated Java code, and javadoc rejects them. Can the tags just be ignored, but their text preserved as straight javadoc? the @group tags are probably ignorable.
I also find that @param tags on Scala class declarations, which intend to document constructor params, get translated as @param tags for class javadoc. This is only valid for generic types. Ideally these would be translated as javadoc for the generated constructors?
Ignoring tags would be easy but anything more complicated is currently out of scope. There is an existing ticket for documenting constructor arguments (#4).
@jodersky I know you were looking at this, a little bit; this may be a duplicate and/or stale at this point.
Thx for the heads-up! Fyi, I won't have time to look into this for the next week On May 1, 2016 6:42 AM, "Sean Owen" [email protected] wrote:
@jodersky https://github.com/jodersky I know you were looking at this, a little bit; this may be a duplicate and/or stale at this point.
— You are receiving this because you were mentioned. Reply to this email directly or view it on GitHub https://github.com/typesafehub/genjavadoc/issues/44#issuecomment-216042802