Clarify some javadoc

not-napoleon · Feb 12, 2024 · 8101eb1 · 8101eb1
1 parent a50e58d
commit 8101eb1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/server/src/main/java/org/elasticsearch/index/mapper/VersionFieldMapper.java b/server/src/main/java/org/elasticsearch/index/mapper/VersionFieldMapper.java
@@ -21,7 +21,11 @@
 
 import java.util.Collections;
 
-/** Mapper for the _version field. */
+/** Mapper for the _version field.
+ *
+ *  This is the field mapper for the monotonically increasing document version.  If you are looking for the field that stores semver style
+ *  strings in a sortable binary format, you want VersionStringFieldMapper in the xpack VersionField plugin
+ */
 public class VersionFieldMapper extends MetadataFieldMapper {
 
     public static final String NAME = "_version";

diff --git a/...-version/src/main/java/org/elasticsearch/xpack/versionfield/VersionStringFieldMapper.java b/...-version/src/main/java/org/elasticsearch/xpack/versionfield/VersionStringFieldMapper.java
@@ -75,6 +75,10 @@
 
 /**
  * A {@link FieldMapper} for indexing fields with version strings.
+ *
+ * The binary encoding of these strings will sort without decoding, according to semver.  See {@link VersionEncoder}
+ *
+ * NB: If you are looking for the document version field _version, you want {@link org.elasticsearch.index.mapper.VersionFieldMapper}
  */
 public class VersionStringFieldMapper extends FieldMapper {