lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Lucene-java Wiki] Update of "Documentation Improvements" by DoronCohen
Date Sat, 09 Jun 2007 08:09:36 GMT
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 DoronCohen:
http://wiki.apache.org/lucene-java/Documentation_Improvements

------------------------------------------------------------------------------
  = Tutorial =
  
   * The demo/tutorial needs to be brought into the current Lucene  century.  
-  * See https://issues.apache.org/jira/browse/LUCENE-805  
+  * See [https://issues.apache.org/jira/browse/LUCENE-805 LUCENE-805]
   * Most important part of this, I think is the "big picture" overview of why and when and
how.
  
  = Javadocs =
@@ -31, +31 @@

   * 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, 
+    * [https://issues.apache.org/jira/browse/LUCENE-765 index package - 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
+    * [https://issues.apache.org/jira/browse/LUCENE-925 analysis package - LUCENE-925]
+    * [https://issues.apache.org/jira/browse/LUCENE-926 document package - LUCENE-926]
+    * [https://issues.apache.org/jira/browse/LUCENE-927 store package - 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

Mime
View raw message