Skip to content

Handle JavaDoc generation warnings #2981

New issue
New issue
Open
Open
Handle JavaDoc generation warnings#2981
Labels
bugdocumentation
@pivovarit

Description

@pivovarit
pivovarit
opened on Feb 1, 2025

Doclint job returns quite a few soft warnings for JavaDocs: you can run it locally with mvn javadoc:javadoc

It returns now 51 warnings:

[WARNING] Javadoc Warnings
[WARNING] warning: URL https://docs.oracle.com/javase/8/docs/api/element-list was redirected to https://docs.oracle.com/javase/8/docs/api/ -- Update the command-line options to suppress this warning.
[WARNING] warning: The code being documented uses modules but the packages defined in https://docs.oracle.com/javase/8/docs/api/ are in the unnamed module.
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1180: warning: no @param for <T1>
[WARNING] public static class Property8<T1, T2, T3, T4, T5, T6, T7, T8> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1180: warning: no @param for <T2>
[WARNING] public static class Property8<T1, T2, T3, T4, T5, T6, T7, T8> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1180: warning: no @param for <T3>
[WARNING] public static class Property8<T1, T2, T3, T4, T5, T6, T7, T8> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1180: warning: no @param for <T4>
[WARNING] public static class Property8<T1, T2, T3, T4, T5, T6, T7, T8> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1180: warning: no @param for <T5>
[WARNING] public static class Property8<T1, T2, T3, T4, T5, T6, T7, T8> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1180: warning: no @param for <T6>
[WARNING] public static class Property8<T1, T2, T3, T4, T5, T6, T7, T8> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1180: warning: no @param for <T7>
[WARNING] public static class Property8<T1, T2, T3, T4, T5, T6, T7, T8> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1180: warning: no @param for <T8>
[WARNING] public static class Property8<T1, T2, T3, T4, T5, T6, T7, T8> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1081: warning: no @param for <T1>
[WARNING] public static class Property7<T1, T2, T3, T4, T5, T6, T7> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1081: warning: no @param for <T2>
[WARNING] public static class Property7<T1, T2, T3, T4, T5, T6, T7> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1081: warning: no @param for <T3>
[WARNING] public static class Property7<T1, T2, T3, T4, T5, T6, T7> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1081: warning: no @param for <T4>
[WARNING] public static class Property7<T1, T2, T3, T4, T5, T6, T7> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1081: warning: no @param for <T5>
[WARNING] public static class Property7<T1, T2, T3, T4, T5, T6, T7> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1081: warning: no @param for <T6>
[WARNING] public static class Property7<T1, T2, T3, T4, T5, T6, T7> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:1081: warning: no @param for <T7>
[WARNING] public static class Property7<T1, T2, T3, T4, T5, T6, T7> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:986: warning: no @param for <T1>
[WARNING] public static class Property6<T1, T2, T3, T4, T5, T6> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:986: warning: no @param for <T2>
[WARNING] public static class Property6<T1, T2, T3, T4, T5, T6> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:986: warning: no @param for <T3>
[WARNING] public static class Property6<T1, T2, T3, T4, T5, T6> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:986: warning: no @param for <T4>
[WARNING] public static class Property6<T1, T2, T3, T4, T5, T6> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:986: warning: no @param for <T5>
[WARNING] public static class Property6<T1, T2, T3, T4, T5, T6> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:986: warning: no @param for <T6>
[WARNING] public static class Property6<T1, T2, T3, T4, T5, T6> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:895: warning: no @param for <T1>
[WARNING] public static class Property5<T1, T2, T3, T4, T5> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:895: warning: no @param for <T2>
[WARNING] public static class Property5<T1, T2, T3, T4, T5> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:895: warning: no @param for <T3>
[WARNING] public static class Property5<T1, T2, T3, T4, T5> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:895: warning: no @param for <T4>
[WARNING] public static class Property5<T1, T2, T3, T4, T5> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:895: warning: no @param for <T5>
[WARNING] public static class Property5<T1, T2, T3, T4, T5> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:808: warning: no @param for <T1>
[WARNING] public static class Property4<T1, T2, T3, T4> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:808: warning: no @param for <T2>
[WARNING] public static class Property4<T1, T2, T3, T4> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:808: warning: no @param for <T3>
[WARNING] public static class Property4<T1, T2, T3, T4> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:808: warning: no @param for <T4>
[WARNING] public static class Property4<T1, T2, T3, T4> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:725: warning: no @param for <T1>
[WARNING] public static class Property3<T1, T2, T3> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:725: warning: no @param for <T2>
[WARNING] public static class Property3<T1, T2, T3> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:725: warning: no @param for <T3>
[WARNING] public static class Property3<T1, T2, T3> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:646: warning: no @param for <T1>
[WARNING] public static class Property2<T1, T2> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:646: warning: no @param for <T2>
[WARNING] public static class Property2<T1, T2> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src-gen/main/java/io/vavr/test/Property.java:571: warning: no @param for <T1>
[WARNING] public static class Property1<T1> implements Checkable {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/Arbitrary.java:164: warning: no comment
[WARNING] default Arbitrary<T> peek(Consumer<? super T> action) {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/Gen.java:72: warning: no comment
[WARNING] static <T> Gen<T> of(T seed, Function<? super T, ? extends T> next) {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/Gen.java:406: warning: no comment
[WARNING] default Gen<T> peek(Consumer<? super T> action) {
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/CheckResult.java:319: warning: no comment
[WARNING] private final int count;
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/CheckResult.java:320: warning: no comment
[WARNING] private final Error error;
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/CheckResult.java:318: warning: no comment
[WARNING] private final String propertyName;
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/CheckResult.java:321: warning: no comment
[WARNING] private final Option<Tuple> sample;
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/CheckResult.java:237: warning: no comment
[WARNING] private final int count;
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/CheckResult.java:236: warning: no comment
[WARNING] private final String propertyName;
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/CheckResult.java:238: warning: no comment
[WARNING] private final Tuple sample;
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/CheckResult.java:155: warning: no comment
[WARNING] private final int count;
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/CheckResult.java:156: warning: no comment
[WARNING] private final boolean exhausted;
[WARNING] ^
[WARNING] /Users/pivovarit/Dev/vavr/vavr-test/src/main/java/io/vavr/test/CheckResult.java:154: warning: no comment
[WARNING] private final String propertyName;
[WARNING] ^
[WARNING] Copying file /Users/pivovarit/Dev/vavr/vavr-test/../.javadoc/stylesheet.css to file stylesheet.css...
[WARNING] 51 warnings

We need to take care of them and then start failing jobs

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugdocumentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions