[
https://issues.apache.org/jira/browse/LUCENE-2209?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12800304#action_12800304
]
Hoss Man commented on LUCENE-2209:
----------------------------------
small suggestion...
@todo is a pretty wide spread and long used custom javadoc tag, so most people
don't worry about it ... but for any other custom tags that projects use, it's
strongly suggested that they always have a "." in their name. The Javadoc
compatibility contract is that future versions of javadoc won't add tags that
have periods in their name so it's the way to avoid collisions (you should
actauly see a warning about using a tag without a "." in it's name from javadoc
when you declare these.
So i would suggest @lucene.internal, @lucene.expert, @lucene.experimental,
etc...
> add @experimental javadocs tag
> ------------------------------
>
> Key: LUCENE-2209
> URL: https://issues.apache.org/jira/browse/LUCENE-2209
> Project: Lucene - Java
> Issue Type: Task
> Components: Javadocs
> Reporter: Robert Muir
> Attachments: LUCENE-2209.patch
>
>
> There are a lot of things marked experimental, api subject to change, etc. in
> lucene.
> this patch simply adds a @experimental tag to common-build.xml so that we can
> use it, for more consistency.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: java-dev-h...@lucene.apache.org
