Tomoko Uchida created LUCENE-8873:
-------------------------------------
Summary: Improve analyzer factoryies' Javadoc.
Key: LUCENE-8873
URL: https://issues.apache.org/jira/browse/LUCENE-8873
Project: Lucene - Core
Issue Type: Improvement
Components: modules/analysis
Reporter: Tomoko Uchida
Currently, the documentation for analyzer factories (subclasses of
{{TokenizerFactory}}, {{CharFilterFactory}}, {{TokenFilterFactory}}) still
includes lots of Solr schema.xml examples and not all properties are
documented. From my perspective, the latter is more problematic because users
who want to use the factories have to refer to source code to know what
properties are defined.
To improve documentation, XML examples should be removed for cleanup, and
instead, *all properties which can be passed to factory constructors should be
properly documented*.
Documentation is often overlooked so some validation rules and standardization
effort would be desired (e.g. marking properties by annotations).
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
