On Oct 7, 2009, at 2:59 PM, Michael Busch (JIRA) wrote:
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.
Related to this Collector is marked as "experimental" but it is the
recommended way for collection if TopDocs is not appropriate.
How about grepping for experimental and expert and reviewing their
recommendations. Perhaps some of what is marked is no longer that way.
-- DM
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: java-dev-h...@lucene.apache.org
