lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Simon Willnauer (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (LUCENE-4525) JavaDoc of SearcherManager#close is not crystal clear
Date Fri, 02 Nov 2012 12:47:12 GMT

     [ https://issues.apache.org/jira/browse/LUCENE-4525?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Simon Willnauer updated LUCENE-4525:
------------------------------------

    Attachment: LUCENE-4525.patch

more javadocs.

some of those IOExc. are due to subclasses and we should not really make specific comments
about when they are thrown. I tried to make them generic. Regarding 3.6 we won't release any
3.6.x anymore or very very unlikely. I don't think that is needed.
                
> JavaDoc of SearcherManager#close is not crystal clear
> -----------------------------------------------------
>
>                 Key: LUCENE-4525
>                 URL: https://issues.apache.org/jira/browse/LUCENE-4525
>             Project: Lucene - Core
>          Issue Type: Improvement
>          Components: core/search
>    Affects Versions: 3.6.1, 4.0
>            Reporter: Michael Osipov
>            Assignee: Simon Willnauer
>            Priority: Minor
>         Attachments: LUCENE-4525.patch, LUCENE-4525.patch
>
>
> Raised from http://www.mail-archive.com/java-user@lucene.apache.org/msg40064.html
> The JavaDoc says:
> {noformat}
>   /**
>    * Close this ReferenceManager to future {@link #acquire() acquiring}. Any
>    * references that were previously {@link #acquire() acquired} won't be
>    * affected, and they should still be {@link #release released} when they are
>    * not needed anymore.
>    */
> {noformat}
> The first sentence is not really clear. I would expect something like:
> {noformat}
> Close this ReferenceManager when the application is shutting down or the
>  underlying index will be disposed. Any references that were previously
>  {@link #acquire() acquired} won't be affected, and they should still be 
> {@link #release released} when they are not needed anymore.
> {noformat}
> Further more, the JavaDoc does not declare that an exception will be thrown on any method.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message