svn commit: r1391182 - in /lucene/dev/branches/lucene_solr_4_0: ./ lucene/ lucene/core/ lucene/core/src/java/org/apache/lucene/codecs/FilterCodec.java

[us...@apache.org]

Author: uschindler
Date: Thu Sep 27 19:32:33 2012
New Revision: 1391182

URL: http://svn.apache.org/viewvc?rev=1391182&view=rev
Log:
Merged revision(s) 1391177 from lucene/dev/trunk:
Fix javadocs.

Modified:
    lucene/dev/branches/lucene_solr_4_0/   (props changed)
    lucene/dev/branches/lucene_solr_4_0/lucene/   (props changed)
    lucene/dev/branches/lucene_solr_4_0/lucene/core/   (props changed)
    lucene/dev/branches/lucene_solr_4_0/lucene/core/src/java/org/apache/lucene/codecs/FilterCodec.java

Modified: lucene/dev/branches/lucene_solr_4_0/lucene/core/src/java/org/apache/lucene/codecs/FilterCodec.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene_solr_4_0/lucene/core/src/java/org/apache/lucene/codecs/FilterCodec.java?rev=1391182&r1=1391181&r2=1391182&view=diff
==============================================================================
--- lucene/dev/branches/lucene_solr_4_0/lucene/core/src/java/org/apache/lucene/codecs/FilterCodec.java (original)
+++ lucene/dev/branches/lucene_solr_4_0/lucene/core/src/java/org/apache/lucene/codecs/FilterCodec.java Thu Sep 27 19:32:33 2012
@@ -47,9 +47,13 @@ package org.apache.lucene.codecs;
  */
 public abstract class FilterCodec extends Codec {
 
+  /** The codec to filter. */
   protected final Codec delegate;
   
-  /** Sole constructor. */
+  /** Sole constructor. When subclassing this codec,
+   * create a no-arg ctor and pass the delegate codec
+   * and a unique name to this ctor.
+   */
   protected FilterCodec(String name, Codec delegate) {
     super(name);
     this.delegate = delegate;