lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jan Høydahl (JIRA) <j...@apache.org>
Subject [jira] Commented: (SOLR-2379) Improve documentation of Analyzers and Tokenizers
Date Fri, 25 Feb 2011 13:45:39 GMT

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

Jan Høydahl commented on SOLR-2379:
-----------------------------------

Few of the TokenFilterFactories are documented at all. Some of them have a simple XML config
snippet example. Take the StandardTokenFilterFactory. It had no class JavaDoc until two days
ago, when Koji and yourself added an xml snippet.

But should the documentation be on the Factory or on the Filter? The WordDelimiterFilterFactory
is not documented but the Filter itself is (although it is not correctly HTML formatted so
it looks broken in the browser).

I think a reasonable goal, at least for these plugin type of classes, is to use the JavaDoc
as the official main doc and point from Wiki to there. But then the Class-level JavaDoc must
give a short introduction to what the filter does, when it is typically used along with a
list of all valid parameters and their values.

> Improve documentation of Analyzers and Tokenizers
> -------------------------------------------------
>
>                 Key: SOLR-2379
>                 URL: https://issues.apache.org/jira/browse/SOLR-2379
>             Project: Solr
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jan Høydahl
>            Priority: Minor
>              Labels: wiki
>
> See thread http://search-lucene.com/m/S7l5XMQ8iA1
> The Wiki page http://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters as well as
http://wiki.apache.org/solr/LanguageAnalysis are not up to date with current state.

-- 
This message is automatically generated by JIRA.
-
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


Mime
View raw message