From 3501d927de82909b80d8647f86cb6af0f3bb4500 Mon Sep 17 00:00:00 2001 From: Michael McCandless Date: Thu, 10 Dec 2009 22:03:30 +0000 Subject: [PATCH] LUCENE-2144: add javadoc warning to AbstractAllTermDocs git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@889440 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/lucene/index/AbstractAllTermDocs.java | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/java/org/apache/lucene/index/AbstractAllTermDocs.java b/src/java/org/apache/lucene/index/AbstractAllTermDocs.java index e3d9094810d..3b0a7132650 100644 --- a/src/java/org/apache/lucene/index/AbstractAllTermDocs.java +++ b/src/java/org/apache/lucene/index/AbstractAllTermDocs.java @@ -19,6 +19,13 @@ package org.apache.lucene.index; import java.io.IOException; +/** Base class for enumerating all but deleted docs. + * + *

NOTE: this class is meant only to be used internally + * by Lucene; it's only public so it can be shared across + * packages. This means the API is freely subject to + * change, and, the class could be removed entirely, in any + * Lucene release. Use directly at your own risk! */ public abstract class AbstractAllTermDocs implements TermDocs { protected int maxDoc;