[LUCENE-8873] Improve analyzer factoryies' Javadoc.

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Component/s: modules/analysis
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Tomoko Uchida
• Created: 22/Jun/19 02:37
• Updated: 28/Aug/22 15:47

Description

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

 

Issue Links

• blocks: LUCENE-8566 Deprecate methods in CustomAnalyzer.Builder which take factory classes