You are viewing a plain text version of this content. The canonical link for it is here.

Posted to java-commits@lucene.apache.org by Apache Wiki <wi...@apache.org> on 2007/06/08 04:39:28 UTC

[Lucene-java Wiki] Update of "Documentation Improvements" by GrantIngersoll

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Lucene-java Wiki" for change notification.

The following page has been changed by GrantIngersoll:
http://wiki.apache.org/lucene-java/Documentation_Improvements

------------------------------------------------------------------------------
  
   * automated tools to help identify missing javadocs?
   * is there any way to easily allow annotation of javadocs (ala PHP and MySql)
-  * Need package level docs for every package- see: https://issues.apache.org/jira/browse/LUCENE-765
+  * Need package level docs for every package- see: 
+        https://issues.apache.org/jira/browse/LUCENE-765, 
+        https://issues.apache.org/jira/browse/LUCENE-925, https://issues.apache.org/jira/browse/LUCENE-926, https://issues.apache.org/jira/browse/LUCENE-927
   * Need class level docs for every public class
   * Need method level docs for every public method - particularly all methods used in any tutorial or "In Depth"  doc (ie: scoring.html, and any similar docs that get written)
   * "core plus contribs" nature of javadocs hard to understand for new users ... plethora of classes can be overwelming and hard to navigate - see: https://issues.apache.org/jira/browse/LUCENE-897