Uploaded image for project: 'Lucene - Core'
  1. Lucene - Core
  2. LUCENE-8873

Improve analyzer factoryies' Javadoc.

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: modules/analysis
    • Labels:
      None
    • Lucene Fields:
      New

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

       

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                tomoko Tomoko Uchida
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: