lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Chris Hostetter <hossman_luc...@fucit.org>
Subject Re: Documentation Suggestion
Date Tue, 21 Jul 2009 23:45:39 GMT

: OK, I agree this makes sense and would be good for major features.
: 
: Btw: For the new TokenStream API I wrote in the original patch (JIRA-1422) a
: quite elaborate section in the package.html of the analysis package.

Yeah ... whenever javadocs make sense, they're probably better then wiki 
docs ... in the case of Solr the userbase is rarely Java users, so it's 
good to have hollistic documentation somewhere other then javadocs.

To me, the key is to make sure all functionality is documented *somewhere* 
before it gets committed.  if it makes sense in javadocs great, if it's 
too widespread to fit neatly into the javadoc method/class/package 
structure, a wiki ting everything together is handy.

That said: even with simple javadocs, having them on the wiki makes it a 
lot easier to read then needing to downlaod/apply the patch *then* 
generate javadocs to read the cross linked info.


-Hoss


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Mime
View raw message