[
https://issues.apache.org/jira/browse/LUCENE-7585?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15758938#comment-15758938
]
Ahmet Arslan commented on LUCENE-7585:
--------------------------------------
I tried adding javadocs to fields in the interface, but it did not solve the
missing javadocs problem.
{{documentation-lint}} complains/fails for the lucene/analysis/modules, which
are explicitly defined with the level of method in
[lucene/build.xml|https://github.com/apache/lucene-solr/blob/master/lucene/build.xml]
{code:xml}
<check-missing-javadocs dir="build/docs/analyzers-icu" level="method"/>
<check-missing-javadocs dir="build/docs/analyzers-morfologik"
level="method"/>
<check-missing-javadocs dir="build/docs/analyzers-phonetic" level="method"/>
<check-missing-javadocs dir="build/docs/analyzers-stempel" level="method"/>
<check-missing-javadocs dir="build/docs/suggest" level="method"/>
{code}
I figured that this method=(level|class|none) thing is about
[checkJavaDocs.py|https://github.com/apache/lucene-solr/blob/master/dev-tools/scripts/checkJavaDocs.py].
Any pointer how to document interface fields so that level="method" passes in
checkJavaDocs.py?
Or, can we remove above xml fragment from build.xml?
> Interface for common parameters used across analysis factories
> --------------------------------------------------------------
>
> Key: LUCENE-7585
> URL: https://issues.apache.org/jira/browse/LUCENE-7585
> Project: Lucene - Core
> Issue Type: Improvement
> Components: modules/analysis
> Affects Versions: 6.3
> Reporter: Ahmet Arslan
> Assignee: David Smiley
> Priority: Minor
> Fix For: master (7.0)
>
> Attachments: LUCENE-7585.patch, LUCENE-7585.patch, LUCENE-7585.patch
>
>
> Certain parameters (String constants) are same/common for multiple analysis
> factories. Some examples are {{ignoreCase}}, {{dictionary}}, and
> {{preserveOriginal}}. These string constants are handled inconsistently in
> different factories. This is an effort to define most common constants in
> ({{CommonAnalysisFactoryParams}}) interface and reuse them.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
