lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rm...@apache.org
Subject svn commit: r1332696 - in /lucene/dev/trunk/lucene: ./ analysis/common/src/java/org/apache/lucene/analysis/util/ analysis/common/src/java/org/tartarus/snowball/ analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/ analysis/morfologik/src/java/org/...
Date Tue, 01 May 2012 15:17:55 GMT
Author: rmuir
Date: Tue May  1 15:17:54 2012
New Revision: 1332696

URL: http://svn.apache.org/viewvc?rev=1332696&view=rev
Log:
LUCENE-3902: start enforcing class javadocs for modules that don't have problems

Removed:
    lucene/dev/trunk/lucene/analysis/common/src/java/org/tartarus/snowball/TestApp.java
Modified:
    lucene/dev/trunk/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/ResourceLoader.java
    lucene/dev/trunk/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/ResourceLoaderAware.java
    lucene/dev/trunk/lucene/analysis/common/src/java/org/tartarus/snowball/Among.java
    lucene/dev/trunk/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseTokenizer.java
    lucene/dev/trunk/lucene/analysis/morfologik/src/java/org/apache/lucene/analysis/morfologik/MorphosyntacticTagAttributeImpl.java
    lucene/dev/trunk/lucene/build.xml

Modified: lucene/dev/trunk/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/ResourceLoader.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/ResourceLoader.java?rev=1332696&r1=1332695&r2=1332696&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/ResourceLoader.java
(original)
+++ lucene/dev/trunk/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/ResourceLoader.java
Tue May  1 15:17:54 2012
@@ -21,6 +21,9 @@ import java.io.IOException;
 import java.io.InputStream;
 import java.util.List;
 
+/**
+ * Abstraction for loading resources (streams, files, and classes).
+ */
 public interface ResourceLoader {
 
   public InputStream openResource(String resource) throws IOException;

Modified: lucene/dev/trunk/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/ResourceLoaderAware.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/ResourceLoaderAware.java?rev=1332696&r1=1332695&r2=1332696&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/ResourceLoaderAware.java
(original)
+++ lucene/dev/trunk/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/ResourceLoaderAware.java
Tue May  1 15:17:54 2012
@@ -17,6 +17,12 @@
 
 package org.apache.lucene.analysis.util;
 
+/**
+ * Interface for a component that needs to be initialized by
+ * an implementation of {@link ResourceLoader}.
+ * 
+ * @see ResourceLoader
+ */
 public interface ResourceLoaderAware {
 
   void inform(ResourceLoader loader);

Modified: lucene/dev/trunk/lucene/analysis/common/src/java/org/tartarus/snowball/Among.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/analysis/common/src/java/org/tartarus/snowball/Among.java?rev=1332696&r1=1332695&r2=1332696&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/analysis/common/src/java/org/tartarus/snowball/Among.java (original)
+++ lucene/dev/trunk/lucene/analysis/common/src/java/org/tartarus/snowball/Among.java Tue
May  1 15:17:54 2012
@@ -33,6 +33,15 @@ package org.tartarus.snowball;
 
 import java.lang.reflect.Method;
 
+/**
+ * This is the rev 502 of the Snowball SVN trunk,
+ * but modified:
+ * made abstract and introduced abstract method stem to avoid expensive reflection in filter
class.
+ * refactored StringBuffers to StringBuilder
+ * uses char[] as buffer instead of StringBuffer/StringBuilder
+ * eq_s,eq_s_b,insert,replace_s take CharSequence like eq_v and eq_v_b
+ * reflection calls (Lovins, etc) use EMPTY_ARGS/EMPTY_PARAMS
+ */
 public class Among {
     private static final Class<?>[] EMPTY_PARAMS = new Class[0];
     public Among (String s, int substring_i, int result,

Modified: lucene/dev/trunk/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseTokenizer.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseTokenizer.java?rev=1332696&r1=1332695&r2=1332696&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseTokenizer.java
(original)
+++ lucene/dev/trunk/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseTokenizer.java
Tue May  1 15:17:54 2012
@@ -100,9 +100,21 @@ public final class JapaneseTokenizer ext
    */
   public static final Mode DEFAULT_MODE = Mode.SEARCH;
 
+  /**
+   * Token type reflecting the original source of this token
+   */
   public enum Type {
+    /**
+     * Known words from the system dictionary.
+     */
     KNOWN,
+    /**
+     * Unknown words (heuristically segmented).
+     */
     UNKNOWN,
+    /**
+     * Known words from the user dictionary.
+     */
     USER
   }
 

Modified: lucene/dev/trunk/lucene/analysis/morfologik/src/java/org/apache/lucene/analysis/morfologik/MorphosyntacticTagAttributeImpl.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/analysis/morfologik/src/java/org/apache/lucene/analysis/morfologik/MorphosyntacticTagAttributeImpl.java?rev=1332696&r1=1332695&r2=1332696&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/analysis/morfologik/src/java/org/apache/lucene/analysis/morfologik/MorphosyntacticTagAttributeImpl.java
(original)
+++ lucene/dev/trunk/lucene/analysis/morfologik/src/java/org/apache/lucene/analysis/morfologik/MorphosyntacticTagAttributeImpl.java
Tue May  1 15:17:54 2012
@@ -21,6 +21,7 @@ package org.apache.lucene.analysis.morfo
 import org.apache.lucene.util.AttributeImpl;
 
 /**
+ * Morphosyntactic annotations for surface forms.
  * @see MorphosyntacticTagAttribute
  */
 public class MorphosyntacticTagAttributeImpl extends AttributeImpl 

Modified: lucene/dev/trunk/lucene/build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/build.xml?rev=1332696&r1=1332695&r2=1332696&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/build.xml (original)
+++ lucene/dev/trunk/lucene/build.xml Tue May  1 15:17:54 2012
@@ -194,6 +194,34 @@
       <check-broken-links dir="build/docs"/>
       <!-- TODO: change this level=class -->
       <check-missing-javadocs dir="build/docs" level="package"/>
+      <!-- too many classes to fix overall to just enable
+           the above to be level="class" right now, but we
+           can prevent the modules that don't have problems
+           from getting any worse -->
+      <check-missing-javadocs dir="build/docs/analyzers-common" level="class"/>
+      <check-missing-javadocs dir="build/docs/analyzers-icu" level="class"/>
+      <check-missing-javadocs dir="build/docs/analyzers-kuromoji" level="class"/>
+      <check-missing-javadocs dir="build/docs/analyzers-kuromoji" level="class"/>
+      <check-missing-javadocs dir="build/docs/analyzers-morfologik" level="class"/>
+      <check-missing-javadocs dir="build/docs/analyzers-phonetic" level="class"/>
+      <check-missing-javadocs dir="build/docs/analyzers-smartcn" level="class"/>
+      <check-missing-javadocs dir="build/docs/analyzers-stempel" level="class"/>
+      <check-missing-javadocs dir="build/docs/analyzers-uima" level="class"/>
+      <!-- benchmark: problems -->
+      <!-- core: problems -->
+      <!-- demo: problems -->
+      <!-- facet: problems -->
+      <!-- grouping: problems -->
+      <!-- highlighter: problems -->
+      <check-missing-javadocs dir="build/docs/join" level="class"/>
+      <check-missing-javadocs dir="build/docs/memory" level="class"/>
+      <!-- misc: problems -->
+      <!-- queries: problems -->
+      <!-- queryparser: problems -->
+      <!-- sandbox: problems -->
+      <!-- spatial: problems -->
+      <!-- suggest: problems -->
+      <!-- test-framework: problems -->
     </sequential>
   </target>
   



Mime
View raw message