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:19:00 UTC

[jira] [Updated] (SOLR-13733) add 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:all-tabpanel ]

Christine Poerschke updated SOLR-13733:
---------------------------------------
    Attachment: SOLR-13733.patch

> add 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