lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Chris Hostetter <hossman_luc...@fucit.org>
Subject Re: FieldCache documentation/exposure
Date Wed, 28 Feb 2007 22:30:33 GMT

: Guess there are no reservations on the subject; I'll enhance the
: documentation of this mechanism.

Sorry ... i'm a little behind on my mail ...

I wouldn't go advertising it *too* heavily ... i think directly using
FieldCache is definitely an "Expert" level thing, and we tend to keep the
documentation on Expert level stuff minimal with the assumption that
people diging in to that level will familiarize themselves with the code a
bit not just read the javadocs.

that said .. i think it's pretty hard ot have too much javadocs ...
inhancing hte ____ javadocs to explain what ____ is and how it can be used
is always good (wether the blank is field in with FieldCache or the name of
any other class) but i don't think we need to promote it heavily from the
top package level javadocs where it might confuse people looking for basic
info on the simple aspects of the API.




-Hoss


---------------------------------------------------------------------
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