[jira] [Created] (LUCENE-4829) Tokenizer and char and token filter subclasses are not listed in Javadoc for the parent abstract classes

["Jack Krupansky (JIRA)" <ji...@apache.org>]

Jack Krupansky created LUCENE-4829:
--------------------------------------

             Summary: Tokenizer and char and token filter subclasses are not listed in Javadoc for the parent abstract classes
                 Key: LUCENE-4829
                 URL: https://issues.apache.org/jira/browse/LUCENE-4829
             Project: Lucene - Core
          Issue Type: Bug
          Components: general/javadocs
    Affects Versions: 4.2, 4.1, 4.0
            Reporter: Jack Krupansky


Unlike in Lucene 3.6, the various subclasses of tokenizers, char filters, and token filters are not listed as subclasses on the Javadoc page for their abstract parent classes. Someone wanting to browse the full list of Lucene 4.x token filters cannot simply go to the javadoc for TokenFilter.

My understanding is that this is a side effect of the reorganization of "modules" in Lucene that occurred in 4.0. The various subclasses are reported as expected in Lucene 3.6.

Unfortunately, it is not just "optional" filters that are considered optional, but even the most basic "core" filters such as the lower case filter whose package name is in fact "org.apache.lucene.analysis.core", whcih seems to bear an obvious relationship to the package of TokenFilter, org.apache.lucene.analysis.

I consider this a regression from 3.6.

Relevant Javadoc:
http://lucene.apache.org/core/4_1_0/core/org/apache/lucene/analysis/TokenFilter.html
http://lucene.apache.org/core/4_1_0/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html
http://lucene.apache.org/core/3_6_0/api/all/org/apache/lucene/analysis/TokenFilter.html

The good news is that the various subclasses of TokenFilterFactory are in fact reported on the Javadoc for TokenFilterFactory.


--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org