[
https://issues.apache.org/jira/browse/LUCENE-8733?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16798299#comment-16798299
]
Christine Poerschke commented on LUCENE-8733:
---------------------------------------------
bq. Most of the classes whose documentation is updated are package-private ...
Understood. It seems easier though to just add it for all the classes in the
package rather than consider on each one if it's required or not?
bq. ... so this will never show up in javadocs?
Yes and no. It will not show up in the https://lucene.apache.org/core published
javadocs, yes. However it would still be visible in developers' IDE (perhaps
there's a different way to obtain visibility there too, haven't looked into)
and also it's possible to re-generate more extended javadocs locally e.g. via
{code}
ant javadocs -Djavadoc.access=private
{code}
(something I learnt 'way back when' on LUCENE-6571 ticket).
> retrospectively add @since javadocs for 'intervals' classes
> -----------------------------------------------------------
>
> Key: LUCENE-8733
> URL: https://issues.apache.org/jira/browse/LUCENE-8733
> Project: Lucene - Core
> Issue Type: Wish
> Reporter: Christine Poerschke
> Assignee: Christine Poerschke
> Priority: Minor
> Attachments: LUCENE-8733-branch-7-4.patch
>
>
> LUCENE-8196 started 'intervals' and subsequent tickets extended it.
> This ticket proposes to retrospectively add {{@since X.Y}} javadocs for all
> the classes (and to then going forward perhaps continue to add them).
> And perhaps we could have an 'intervals' or similar JIRA components choice
> too?
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
