You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Christine Poerschke (Jira)" <ji...@apache.org> on 2019/09/02 16:23:00 UTC
[jira] [Commented] (SOLR-13733) add more class-level javadocs for
public org.apache.solr.metrics classes
[ https://issues.apache.org/jira/browse/SOLR-13733?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16920959#comment-16920959 ]
Christine Poerschke commented on SOLR-13733:
--------------------------------------------
Attached patch is partial e.g. for [SolrRrdBackend.java|https://github.com/apache/lucene-solr/blob/releases/lucene-solr/8.2.0/solr/core/src/java/org/apache/solr/metrics/rrd/SolrRrdBackend.java#L32] I couldn't easily see what a good description might be and [JmxMetricsReporter.java|https://github.com/apache/lucene-solr/blob/releases/lucene-solr/8.2.0/solr/core/src/java/org/apache/solr/metrics/reporters/jmx/JmxMetricsReporter.java] has some inner {{public interface ...}} classes/interfaces which don't yet have javadocs.
> add more class-level javadocs for public org.apache.solr.metrics classes
> ------------------------------------------------------------------------
>
> Key: SOLR-13733
> URL: https://issues.apache.org/jira/browse/SOLR-13733
> Project: Solr
> Issue Type: Task
> Reporter: Christine Poerschke
> Priority: Minor
> Attachments: SOLR-13733.patch
>
>
> Most public {{org.apache.solr.metrics}} classes already have class-level javadocs and adding javadocs for the few that don't have them yet could be a step towards {{ant precommit}} requiring(\*) javadocs (class-level only, for public classes, for org.apache.solr.metrics) selectively on an opt-in basis.
> (\*) = e.g. via {{solr/build.xml}} content like this:
> {code}
> <check-missing-javadocs dir="${javadoc.dir}/solr-core/org/apache/solr/metrics" level="class"/>
> {code}
--
This message was sent by Atlassian Jira
(v8.3.2#803003)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org