Fix javadocs.

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1391177 13f79535-47bb-0310-9956-ffa450edef68
2012-09-27 19:29:37 +00:00 · 2012-09-27 19:29:37 +00:00 · 9639baaa32
parent f37e5e2de6
commit 9639baaa32
1 changed files with 5 additions and 1 deletions
--- a/lucene/core/src/java/org/apache/lucene/codecs/FilterCodec.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/FilterCodec.java
@ -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;