search

eclipse / microprofile-metrics

microprofile-metrics
Apache License 2.0
100 stars 66 forks source link

Errors in MicroProfile 6.0 javadoc generation #764

Closed steven1046 closed 1 year ago

steven1046 commented 1 year ago

I found 11 errors while using the javadoc command with the following java version:

openjdk 11.0.17 2022-10-18
IBM Semeru Runtime Open Edition 11.0.17.0 (build 11.0.17+8)

I got the source code from the respective links for MicroProfile 6.0 here: https://github.com/eclipse/microprofile/releases

Errors:

./org/eclipse/microprofile/metrics/Snapshot.java:57: error: reference not found
     * @return an array of {@link percentileValue}
     * 
 ./org/eclipse/microprofile/metrics/annotation/RegistryScope.java:51: error: reference not found
 * see {@link MetricRegistry.APPLICATION_SCOPE}, {@link MetricRegistry.BASE_SCOPE} and
              ^
./org/eclipse/microprofile/metrics/annotation/RegistryScope.java:51: error: reference not found
 * see {@link MetricRegistry.APPLICATION_SCOPE}, {@link MetricRegistry.BASE_SCOPE} and
                                                        ^
./org/eclipse/microprofile/metrics/annotation/RegistryScope.java:52: error: reference not found
 * {@link MetricRegistry.VENDOR_SCOPE}

./org/eclipse/microprofile/metrics/annotation/Counted.java:141: error: reference not found
     * @return The scope this counter belongs to. By default, the value is {@link MetricRegistry.APPLICATION_SCOPE}.
                                                                                  ^
Generating ../javadoc/org/eclipse/microprofile/metrics/annotation/Gauge.html...
./org/eclipse/microprofile/metrics/annotation/Gauge.java:115: error: reference not found
     * @return The scope this gauge belongs to. By default, the value is {@link MetricRegistry.APPLICATION_SCOPE}.
                                                                                ^
Generating ../javadoc/org/eclipse/microprofile/metrics/annotation/Metric.html...
./org/eclipse/microprofile/metrics/annotation/Metric.java:111: error: reference not found
     * @return The scope this metric belongs to. By default, the value is {@link MetricRegistry.APPLICATION_SCOPE}.
                                                                                 ^
Generating ../javadoc/org/eclipse/microprofile/metrics/annotation/RegistryScope.html...
./org/eclipse/microprofile/metrics/annotation/RegistryScope.java:68: error: reference not found
     *         see {@link MetricRegistry.APPLICATION_SCOPE}, {@link MetricRegistry.BASE_SCOPE} and
                          ^
./org/eclipse/microprofile/metrics/annotation/RegistryScope.java:68: error: reference not found
     *         see {@link MetricRegistry.APPLICATION_SCOPE}, {@link MetricRegistry.BASE_SCOPE} and
                                                                    ^
./org/eclipse/microprofile/metrics/annotation/RegistryScope.java:69: error: reference not found
     *         {@link MetricRegistry.VENDOR_SCOPE}

./org/eclipse/microprofile/metrics/annotation/Timed.java:135: error: reference not found
     * @return The scope this Timer belongs to. By default, the value is {@link MetricRegistry.APPLICATION_SCOPE}.

This is due to slightly invalid javadoc comment syntax.

steven1046 commented 1 year ago

I will open a PR to fix these errors, i don't know how to assign myself to the issue.

donbourne commented 1 year ago

hey @steven1046 , thanks for raising the issue... look forward to seeing your PR!

steven1046 commented 1 year ago

The above PR fixes 10 errors while i found 11 in my local testing. I did not find all 11 errors in the source code, so 1 must have already been fixed.

Channyboy commented 1 year ago

Closing as PR was merged.