Doug Cutting wrote:
Paul Elschot wrote:
I learned a lot by adding some javadocs to such classes. I suppose Doug added the Expert markings, but I don't know their precise purpose.
The "Expert" declaration is meant to indicate that most users should not need to understand the feature. Lucene's API seeks to be both simple and flexible, but this is not always possible. When flexibility is added that is not part of the simple API, it is deemed "expert". For example, we don't expect most users to need to write new Query implementations. So Query methods that are only used internally in query processing are marked "Expert", since they only need to be understood by those implementing a Query.
I think this is an excellent way of giving guidance to users - you want to indicate what they'd normally use, and what they should initially stay away from.
Doug
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
