From 85c6e76ab8e425823c7697a10a18f29feb298c65 Mon Sep 17 00:00:00 2001 From: Robert Muir Date: Thu, 16 Aug 2012 16:00:36 +0000 Subject: [PATCH] javadocs git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1373895 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/lucene/codecs/BlockTermState.java | 12 ++++++++---- .../lucene/codecs/MultiLevelSkipListReader.java | 2 +- .../lucene/codecs/MultiLevelSkipListWriter.java | 4 ++-- .../java/org/apache/lucene/index/DocTermOrds.java | 11 +++++++---- .../src/java/org/apache/lucene/index/FieldInfos.java | 10 +++++----- .../java/org/apache/lucene/index/SegmentInfos.java | 3 ++- .../org/apache/lucene/index/SegmentReadState.java | 10 +++++----- .../org/apache/lucene/index/SegmentWriteState.java | 10 +++++----- .../java/org/apache/lucene/search/IndexSearcher.java | 2 +- .../org/apache/lucene/search/TopDocsCollector.java | 4 ++-- .../java/org/apache/lucene/util/ByteBlockPool.java | 9 ++++++--- .../src/java/org/apache/lucene/util/fst/FST.java | 8 ++++---- 12 files changed, 48 insertions(+), 37 deletions(-) diff --git a/lucene/core/src/java/org/apache/lucene/codecs/BlockTermState.java b/lucene/core/src/java/org/apache/lucene/codecs/BlockTermState.java index 15c77beacc3..131b33973c6 100644 --- a/lucene/core/src/java/org/apache/lucene/codecs/BlockTermState.java +++ b/lucene/core/src/java/org/apache/lucene/codecs/BlockTermState.java @@ -26,11 +26,15 @@ import org.apache.lucene.index.TermState; * terms dict. */ public class BlockTermState extends OrdTermState { - public int docFreq; // how many docs have this term - public long totalTermFreq; // total number of occurrences of this term + /** how many docs have this term */ + public int docFreq; + /** total number of occurrences of this term */ + public long totalTermFreq; - public int termBlockOrd; // the term's ord in the current block - public long blockFilePointer; // fp into the terms dict primary file (_X.tim) that holds this term + /** the term's ord in the current block */ + public int termBlockOrd; + /** fp into the terms dict primary file (_X.tim) that holds this term */ + public long blockFilePointer; @Override public void copyFrom(TermState _other) { diff --git a/lucene/core/src/java/org/apache/lucene/codecs/MultiLevelSkipListReader.java b/lucene/core/src/java/org/apache/lucene/codecs/MultiLevelSkipListReader.java index 107e8656a26..1e70b5abde0 100644 --- a/lucene/core/src/java/org/apache/lucene/codecs/MultiLevelSkipListReader.java +++ b/lucene/core/src/java/org/apache/lucene/codecs/MultiLevelSkipListReader.java @@ -36,7 +36,7 @@ import org.apache.lucene.util.MathUtil; */ public abstract class MultiLevelSkipListReader { - // the maximum number of skip levels possible for this index + /** the maximum number of skip levels possible for this index */ protected int maxNumberOfSkipLevels; // number of levels in this skip list diff --git a/lucene/core/src/java/org/apache/lucene/codecs/MultiLevelSkipListWriter.java b/lucene/core/src/java/org/apache/lucene/codecs/MultiLevelSkipListWriter.java index facef8c1986..6f9309861dd 100644 --- a/lucene/core/src/java/org/apache/lucene/codecs/MultiLevelSkipListWriter.java +++ b/lucene/core/src/java/org/apache/lucene/codecs/MultiLevelSkipListWriter.java @@ -49,7 +49,7 @@ import org.apache.lucene.util.MathUtil; */ public abstract class MultiLevelSkipListWriter { - // number of levels in this skip list + /** number of levels in this skip list */ protected int numberOfSkipLevels; // the skip interval in the list with level = 0 @@ -77,8 +77,8 @@ public abstract class MultiLevelSkipListWriter { } } + /** creates new buffers or empties the existing ones */ protected void resetSkip() { - // creates new buffers or empties the existing ones if (skipBuffer == null) { init(); } else { diff --git a/lucene/core/src/java/org/apache/lucene/index/DocTermOrds.java b/lucene/core/src/java/org/apache/lucene/index/DocTermOrds.java index 500dc3eb8f5..93ac2bb4c81 100644 --- a/lucene/core/src/java/org/apache/lucene/index/DocTermOrds.java +++ b/lucene/core/src/java/org/apache/lucene/index/DocTermOrds.java @@ -119,10 +119,13 @@ public class DocTermOrds { protected final String field; protected int numTermsInField; - protected long termInstances; // total number of references to term numbers + /** total number of references to term numbers */ + protected long termInstances; private long memsz; - protected int total_time; // total time to uninvert the field - protected int phase1_time; // time for phase1 of the uninvert process + /** total time to uninvert the field */ + protected int total_time; + /** time for phase1 of the uninvert process */ + protected int phase1_time; protected int[] index; protected byte[][] tnums = new byte[256][]; @@ -234,7 +237,7 @@ public class DocTermOrds { protected void setActualDocFreq(int termNum, int df) throws IOException { } - // Call this only once (if you subclass!) + /** Call this only once (if you subclass!) */ protected void uninvert(final AtomicReader reader, final BytesRef termPrefix) throws IOException { //System.out.println("DTO uninvert field=" + field + " prefix=" + termPrefix); final long startTime = System.currentTimeMillis(); diff --git a/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java b/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java index f0ff871b64f..9b251153127 100644 --- a/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java +++ b/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java @@ -249,11 +249,11 @@ public class FieldInfos implements Iterable { return addOrUpdateInternal(name, -1, isIndexed, storeTermVector, omitNorms, storePayloads, indexOptions, docValues, normType); } - // NOTE: this method does not carry over termVector - // booleans nor docValuesType; the indexer chain - // (TermVectorsConsumerPerField, DocFieldProcessor) must - // set these fields when they succeed in consuming - // the document: + /** NOTE: this method does not carry over termVector + * booleans nor docValuesType; the indexer chain + * (TermVectorsConsumerPerField, DocFieldProcessor) must + * set these fields when they succeed in consuming + * the document */ public FieldInfo addOrUpdate(String name, IndexableFieldType fieldType) { // TODO: really, indexer shouldn't even call this // method (it's only called from DocFieldProcessor); diff --git a/lucene/core/src/java/org/apache/lucene/index/SegmentInfos.java b/lucene/core/src/java/org/apache/lucene/index/SegmentInfos.java index b92d31a1b65..f1b938e3dab 100644 --- a/lucene/core/src/java/org/apache/lucene/index/SegmentInfos.java +++ b/lucene/core/src/java/org/apache/lucene/index/SegmentInfos.java @@ -133,7 +133,8 @@ public final class SegmentInfos implements Cloneable, Iterable userData = Collections.emptyMap(); // Opaque Map that user can specify during IndexWriter.commit + /** Opaque Map<String, String> that user can specify during IndexWriter.commit */ + public Map userData = Collections.emptyMap(); private List segments = new ArrayList(); diff --git a/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java b/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java index 71b03463968..79be20cc9b6 100644 --- a/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java +++ b/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java @@ -30,11 +30,11 @@ public class SegmentReadState { public final FieldInfos fieldInfos; public final IOContext context; - // NOTE: if this is < 0, that means "defer terms index - // load until needed". But if the codec must load the - // terms index on init (preflex is the only once currently - // that must do so), then it should negate this value to - // get the app's terms divisor: + /** NOTE: if this is < 0, that means "defer terms index + * load until needed". But if the codec must load the + * terms index on init (preflex is the only once currently + * that must do so), then it should negate this value to + * get the app's terms divisor */ public int termsIndexDivisor; public final String segmentSuffix; diff --git a/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java b/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java index 6b161df91d6..0c3dd5cf2eb 100644 --- a/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java +++ b/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java @@ -33,11 +33,11 @@ public class SegmentWriteState { public final FieldInfos fieldInfos; public int delCountOnFlush; - // Deletes to apply while we are flushing the segment. A - // Term is enrolled in here if it was deleted at one - // point, and it's mapped to the docIDUpto, meaning any - // docID < docIDUpto containing this term should be - // deleted. + /** Deletes to apply while we are flushing the segment. A + * Term is enrolled in here if it was deleted at one + * point, and it's mapped to the docIDUpto, meaning any + * docID < docIDUpto containing this term should be + * deleted. */ public final BufferedDeletes segDeletes; // Lazily created: diff --git a/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java b/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java index 389bf3f9abf..68ffa73108d 100644 --- a/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java +++ b/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java @@ -82,7 +82,7 @@ public class IndexSearcher { // in the next release protected final IndexReaderContext readerContext; protected final List leafContexts; - // used with executor - each slice holds a set of leafs executed within one thread + /** used with executor - each slice holds a set of leafs executed within one thread */ protected final LeafSlice[] leafSlices; // These are only used for multi-threaded search diff --git a/lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java b/lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java index afbae972645..5e7dd50406f 100644 --- a/lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java +++ b/lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java @@ -33,8 +33,8 @@ import org.apache.lucene.util.PriorityQueue; */ public abstract class TopDocsCollector extends Collector { - // This is used in case topDocs() is called with illegal parameters, or there - // simply aren't (enough) results. + /** This is used in case topDocs() is called with illegal parameters, or there + * simply aren't (enough) results. */ protected static final TopDocs EMPTY_TOPDOCS = new TopDocs(0, new ScoreDoc[0], Float.NaN); /** diff --git a/lucene/core/src/java/org/apache/lucene/util/ByteBlockPool.java b/lucene/core/src/java/org/apache/lucene/util/ByteBlockPool.java index 3378a3e2141..9a863ffdd5b 100644 --- a/lucene/core/src/java/org/apache/lucene/util/ByteBlockPool.java +++ b/lucene/core/src/java/org/apache/lucene/util/ByteBlockPool.java @@ -117,10 +117,13 @@ public final class ByteBlockPool { public byte[][] buffers = new byte[10][]; int bufferUpto = -1; // Which buffer we are upto - public int byteUpto = BYTE_BLOCK_SIZE; // Where we are in head buffer + /** Where we are in head buffer */ + public int byteUpto = BYTE_BLOCK_SIZE; - public byte[] buffer; // Current head buffer - public int byteOffset = -BYTE_BLOCK_SIZE; // Current head offset + /** Current head buffer */ + public byte[] buffer; + /** Current head offset */ + public int byteOffset = -BYTE_BLOCK_SIZE; private final Allocator allocator; diff --git a/lucene/core/src/java/org/apache/lucene/util/fst/FST.java b/lucene/core/src/java/org/apache/lucene/util/fst/FST.java index dc099696b60..cd97d7086e4 100644 --- a/lucene/core/src/java/org/apache/lucene/util/fst/FST.java +++ b/lucene/core/src/java/org/apache/lucene/util/fst/FST.java @@ -158,7 +158,7 @@ public final class FST { private final boolean packed; private PackedInts.Reader nodeRefToAddress; - // If arc has this label then that arc is final/accepted + /** If arc has this label then that arc is final/accepted */ public static final int END_LABEL = -1; private boolean allowArrayArcs = true; @@ -174,7 +174,7 @@ public final class FST { // building an FST w/ willPackFST=true: int node; - // To node (ord or address): + /** To node (ord or address) */ public int target; byte flags; @@ -542,8 +542,8 @@ public final class FST { return v; } - // returns true if the node at this address has any - // outgoing arcs + /** returns true if the node at this address has any + * outgoing arcs */ public static boolean targetHasArcs(Arc arc) { return arc.target > 0; }