lucene-dev mailing list archives

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

             Summary: 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: 4.0, 3.6.1
            Reporter: Michael Osipov
            Priority: Minor


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