Skip to content

Clean up javadoc for stricter Java 11 #6607

@headius

Description

@headius

We have various places in our javadoc that are rejected by the strict javadoc generator in Java 11. We should be able to build javadoc on all released versions of Java, but at least on 11.

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.7:jar (attach-javadocs) on project jruby-core: MavenReportException: Error while creating archive:
[ERROR] Exit code: 1 - /Users/headius/projects/jruby-9.2/tmp/jruby-dist-build/core/src/main/java/org/jruby/RubyUnboundMethod.java:45: error: unknown tag: note
[ERROR]  * @note This was renamed from UnboundMethod.java
[ERROR]    ^
[ERROR] /Users/headius/projects/jruby-9.2/tmp/jruby-dist-build/core/src/main/java/org/jruby/embed/LocalVariableBehavior.java:34: error: malformed HTML
[ERROR]  * @author Yoko Harada <yokolet@gmail.com>
[ERROR]                        ^
[ERROR] /Users/headius/projects/jruby-9.2/tmp/jruby-dist-build/core/src/main/java/org/jruby/embed/LocalVariableBehavior.java:34: error: bad use of '>'
[ERROR]  * @author Yoko Harada <yokolet@gmail.com>
[ERROR]                                          ^
[ERROR] /Users/headius/projects/jruby-9.2/tmp/jruby-dist-build/core/src/main/java/org/jruby/embed/EvalFailedException.java:35: error: malformed HTML
[ERROR]  * @author Yoko Harada <yokolet@gmail.com>
[ERROR]                        ^
[ERROR] /Users/headius/projects/jruby-9.2/tmp/jruby-dist-build/core/src/main/java/org/jruby/embed/EvalFailedException.java:35: error: bad use of '>'
[ERROR]  * @author Yoko Harada <yokolet@gmail.com>
...

There are several pages of minor things to fix in the javadocs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions