[ 
https://issues.apache.org/jira/browse/LUCENE-7964?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16159499#comment-16159499
 ] 

Jan Høydahl commented on LUCENE-7964:
-------------------------------------

Is there some way to keep the documentation as part of the code itself? This 
way it is kept in sync and various tooling could also ask the class for what 
params it takes and thus drive GUIs. Would a custom annotation work? I guess we 
could still write a tool using SPI to scrape all these annotation strings?

{code:java}
@AnalysisParams("[{name: preserveOriginal, description: \"Whether to keep the 
original term\", type: boolean}]")
public class ASCIIFoldingFilterFactory extends TokenFilterFactory implements 
MultiTermAwareComponent {
  private static final String PRESERVE_ORIGINAL = "preserveOriginal";
{code}

> Remove Solr fieldType XML example from Lucene AnalysisFactories JavaDoc
> -----------------------------------------------------------------------
>
>                 Key: LUCENE-7964
>                 URL: https://issues.apache.org/jira/browse/LUCENE-7964
>             Project: Lucene - Core
>          Issue Type: Improvement
>          Components: general/javadocs
>            Reporter: Jan Høydahl
>            Priority: Trivial
>             Fix For: 7.1
>
>
> As proposed and discussed in this dev-list thread:
> https://lists.apache.org/thread.html/9add7e4a3ad28b307dc51532a609b423982922d734064f26f8104744@%3Cdev.lucene.apache.org%3E
> [~rcmuir] [~dsmiley] [~thetaphi]



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to