search

eclipse / microprofile-metrics

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

Gaps in MP Metrics Javadocs #511

Closed tomjenningss closed 4 years ago

tomjenningss commented 4 years ago

In the Open Liberty docs, some descriptions are absent from the tables in the Javadocs packages. As a result, when developers use the IDE context help, gaps are evident.

All of the Annotation Types need reviewing:Counted, Gauge, Metered, Timed, RegistryType and Metric.

For example, the Optional Elements table is missing several descriptions. The only description present within the table is for boolean, reusable. This goes for all annotation types in the Optional Elements table, and for all versions from 3.0 - 1.2.

Here is a link to the Annotation Type:counted, for context - https://www.openliberty.io/docs/ref/microprofile/2.2/#package=org/eclipse/microprofile/metrics/annotation/package-frame.html&class=org/eclipse/microprofile/metrics/annotation/Counted.html

donbourne commented 4 years ago

@tomjenningss , while you've written this up as an Open Liberty issue, I suspect you put it here (in MicroProfile Metrics) because the root of the issue is that MP Metrics javadoc is missing content at https://download.eclipse.org/microprofile/microprofile-metrics-2.2/apidocs/org/eclipse/microprofile/metrics/annotation/Counted.html