[ https://issues.apache.org/jira/browse/LUCENE-8873?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16904779#comment-16904779 ]
Tomoko Uchida commented on LUCENE-8873: --------------------------------------- As a reminder, we cannot have attributes named "class" or "name" - these are reserved for Solr field type configuration and implicitly erased in the super class constructor. Can we treat this constraint explicitly here by throwing exceptions when a factory violates this assumption? > 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 > Priority: Minor > > 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.14#76016) --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org