lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Busch (JIRA)" <j...@apache.org>
Subject [jira] Created: (LUCENE-1956) Fix javadoc comments in search package
Date Wed, 07 Oct 2009 18:59:31 GMT
Fix javadoc comments in search package
--------------------------------------

                 Key: LUCENE-1956
                 URL: https://issues.apache.org/jira/browse/LUCENE-1956
             Project: Lucene - Java
          Issue Type: Task
          Components: Search
            Reporter: Michael Busch
            Priority: Minor
             Fix For: 3.0


With LUCENE-1856 I removed some old, deprecated search methods, and with the HitCollector
work new ones were introduced in 2.9. We need to fix the javadocs now in the search package,
especially in classes like Searcher, Searchable, MultiSearcher, ParallelMultiSearcher, package.html,
etc. 

We should also make the javadocs more intuitive for the user: currently we call all search
methods in Searchable "low-level" and most of them "expert". I think it's currently very confusing
for the user to understand which methods to use.

-- 
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-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Mime
View raw message