[lucene-solr] branch master updated: LUCENE-9590: Add javadoc for Lucene86PointsFormat class (#2194)

[ds...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dsmiley pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git


The following commit(s) were added to refs/heads/master by this push:
     new 9837bc4  LUCENE-9590: Add javadoc for Lucene86PointsFormat class (#2194)
9837bc4 is described below

commit 9837bc4a4da1c63088a101c20374591f62e0be08
Author: Lu Xugang <q1...@Gmail.com>
AuthorDate: Fri Feb 12 04:25:28 2021 +0800

    LUCENE-9590: Add javadoc for Lucene86PointsFormat class (#2194)
    
    to Lucene's Confluence.
    * also corrected some trivial errors in javadocs & comments
---
 .../java/org/apache/lucene/codecs/lucene86/Lucene86PointsFormat.java | 5 ++++-
 lucene/core/src/java/org/apache/lucene/index/ReadersAndUpdates.java  | 4 ++--
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene86/Lucene86PointsFormat.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene86/Lucene86PointsFormat.java
index 17594c0..0714840 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene86/Lucene86PointsFormat.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene86/Lucene86PointsFormat.java
@@ -35,9 +35,12 @@ import org.apache.lucene.index.SegmentWriteState;
  *   <li>A .kdm file that records metadata about the fields, such as numbers of dimensions or
  *       numbers of bytes per dimension.
  *   <li>A .kdi file that stores inner nodes of the tree.
- *   <li>A .kdm file that stores leaf nodes, where most of the data lives.
+ *   <li>A .kdd file that stores leaf nodes, where most of the data lives.
  * </ul>
  *
+ * See <a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=173081898">this
+ * wiki</a> for detailed data structures of the three files.
+ *
  * @lucene.experimental
  */
 public final class Lucene86PointsFormat extends PointsFormat {
diff --git a/lucene/core/src/java/org/apache/lucene/index/ReadersAndUpdates.java b/lucene/core/src/java/org/apache/lucene/index/ReadersAndUpdates.java
index 3746817..b917be5 100644
--- a/lucene/core/src/java/org/apache/lucene/index/ReadersAndUpdates.java
+++ b/lucene/core/src/java/org/apache/lucene/index/ReadersAndUpdates.java
@@ -66,8 +66,8 @@ final class ReadersAndUpdates {
 
   // Indicates whether this segment is currently being merged. While a segment
   // is merging, all field updates are also registered in the
-  // mergingNumericUpdates map. Also, calls to writeFieldUpdates merge the
-  // updates with mergingNumericUpdates.
+  // mergingDVUpdates map. Also, calls to writeFieldUpdates merge the
+  // updates with mergingDVUpdates.
   // That way, when the segment is done merging, IndexWriter can apply the
   // updates on the merged segment too.
   private boolean isMerging = false;