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 08:57:38 GMT

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

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

Agree. That has the benefit of improving JavaDoc quality as well for a lot of classes.
An example of excellent JavaDoc is the Similarity class: http://lucene.apache.org/java/3_0_3/api/core/org/apache/lucene/search/Similarity.html
Browsing through the analyzers, they are very sparse on javadoc :(

ASIDE: And what about finally making the move to the Confluence Wiki as well (https://cwiki.apache.org/SOLRxSITE/).
Then we could simply include Javadoc inline in pages through the javadoc plugin https://plugins.atlassian.com/plugin/details/11120,
and also get auto linking to Jira issues.

> 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