You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by "Alan Woodward (Jira)" <ji...@apache.org> on 2021/11/22 11:23:00 UTC
[jira] [Comment Edited] (LUCENE-10249) Analysis factories shouldn't have Solr configuration instructions in their javadoc
[ https://issues.apache.org/jira/browse/LUCENE-10249?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17447342#comment-17447342 ]
Alan Woodward edited comment on LUCENE-10249 at 11/22/21, 11:22 AM:
--------------------------------------------------------------------
Here's a suggestion for a replacement javadoc, using the DelimitedBoostTokenFilterFactory as an example:
{code:java}
/**
* Factory for {@link DelimitedBoostTokenFilter}.
*
- * <pre class="prettyprint">
- * <fieldType name="text_dlmtd" class="solr.TextField" positionIncrementGap="100">
- * <analyzer>
- * <tokenizer class="solr.WhitespaceTokenizerFactory"/>
- * <filter class="solr.DelimitedBoostTokenFilterFactory" delimiter="|"/>
- * </analyzer>
- * </fieldType></pre>
+ * Parameters:
+ * {@value #DELIMITER_ATTR} :
+ * default {@value #DEFAULT_DELIMITER}
+ * the character used to separate the boost from the body of the term
*
* @lucene.spi {@value #NAME}
*/
{code}
was (Author: romseygeek):
Here's a suggestions for a replacement javadoc, using the DelimitedBoostTokenFilterFactory as an example:
{code:java}
/**
* Factory for {@link DelimitedBoostTokenFilter}.
*
- * <pre class="prettyprint">
- * <fieldType name="text_dlmtd" class="solr.TextField" positionIncrementGap="100">
- * <analyzer>
- * <tokenizer class="solr.WhitespaceTokenizerFactory"/>
- * <filter class="solr.DelimitedBoostTokenFilterFactory" delimiter="|"/>
- * </analyzer>
- * </fieldType></pre>
+ * Parameters:
+ * {@value #DELIMITER_ATTR} :
+ * default {@value #DEFAULT_DELIMITER}
+ * the character used to separate the boost from the body of the term
*
* @lucene.spi {@value #NAME}
*/
{code}
> Analysis factories shouldn't have Solr configuration instructions in their javadoc
> ----------------------------------------------------------------------------------
>
> Key: LUCENE-10249
> URL: https://issues.apache.org/jira/browse/LUCENE-10249
> Project: Lucene - Core
> Issue Type: Improvement
> Reporter: Alan Woodward
> Priority: Major
>
> Since the analysis factories were moved into lucene, they have contained an XML snippet in their javadoc showing how to configure them in a `solr.xml` file. We should either replace this with something showing how to use the factory in a custom analyzer, or just have a plain table of arguments.
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org