From 9b8a4a9e6e4aa640faa6a9e35fab2f61b126dc07 Mon Sep 17 00:00:00 2001 From: iverase Date: Fri, 22 Feb 2019 11:04:46 +0100 Subject: [PATCH] LUCENE-8699: Add lucene internal tag to PointValue interface and fix some typos --- .../java/org/apache/lucene/util/bkd/PointValue.java | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/lucene/core/src/java/org/apache/lucene/util/bkd/PointValue.java b/lucene/core/src/java/org/apache/lucene/util/bkd/PointValue.java index 79c3efa16c1..28506278782 100644 --- a/lucene/core/src/java/org/apache/lucene/util/bkd/PointValue.java +++ b/lucene/core/src/java/org/apache/lucene/util/bkd/PointValue.java @@ -19,18 +19,19 @@ package org.apache.lucene.util.bkd; import org.apache.lucene.util.BytesRef; -/** - * Represent a dimensional point value written in the BKD tree. - */ +/** Represents a dimensional point value written in the BKD tree. + * + * @lucene.internal + **/ public interface PointValue { - /** Return the packed values for the dimensions */ + /** Returns the packed values for the dimensions */ BytesRef packedValue(); - /** The document id */ + /** Returns the document id */ int docID(); - /** The byte representation of the document id */ + /** Returns the byte representation of the document id */ BytesRef docIDBytes(); }