Apache Lucene open-source search software
javadocs cleanup in Lucene99PostingsFormat (#12776)
Jakub Slowinskifcf687814445
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene99/Lucene99PostingsFormat.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene99/Lucene99PostingsFormat.javaindex f233276c6c5..877746641b4 100644--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene99/Lucene99PostingsFormat.java+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene99/Lucene99PostingsFormat.java@@ -158,8 +158,8 @@ import org.apache.lucene.util.packed.PackedInts;* <dd><b>Frequencies and Skip Data</b>* <p>The .doc file contains the lists of documents which contain each term, along with the* frequency of the term in that document (except when frequencies are omitted: {@link- * IndexOptions#DOCS}). It also saves skip data to the beginning of each packed or VInt block,- * when the length of document list is larger than packed block size.+ * IndexOptions#DOCS}). Skip data is saved at the end of each term's postings. The skip data+ * is saved once for the entire postings list.* <ul>* <li>docFile(.doc) --> Header, <TermFreqs, SkipData?><sup>TermCount</sup>, Footer* <li>Header --> {@link CodecUtil#writeIndexHeader IndexHeader}@@ -174,7 +174,8 @@ import org.apache.lucene.util.packed.PackedInts;* <li>SkipDatum --> DocSkip, DocFPSkip, <PosFPSkip, PosBlockOffset, PayLength?,* PayFPSkip?>?, ImpactLength, <CompetitiveFreqDelta, CompetitiveNormDelta?>* <sup>ImpactCount</sup>, SkipChildLevelPointer?- * <li>PackedDocDeltaBlock, PackedFreqBlock --> {@link PackedInts PackedInts}+ * <li>PackedFreqBlock --> {@link PackedInts PackedInts}, uses patching+ * <li>PackedDocDeltaBlock --> {@link PackedInts PackedInts}, does not use patching* <li>DocDelta, Freq, DocSkip, DocFPSkip, PosFPSkip, PosBlockOffset, PayByteUpto,* PayFPSkip, ImpactLength, CompetitiveFreqDelta --> {@link DataOutput#writeVInt* VInt}