Skip to content

javadoc 8 errors on some translated scaladoc elements #44

Open
@srowen

Description

@srowen

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?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions