Skip to content

Commit

Permalink
Javadoc tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
williamrandolph committed Mar 8, 2024
1 parent 4fe34e0 commit 3daa19c
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions server/src/main/java/org/elasticsearch/env/BuildVersion.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,14 @@
import java.util.ServiceLoader;

/**
* A pluggable version class with a minimal comparison API.
* A version representing the code of Elasticsearch
*
* <p>This class allows us to check whether an Elasticsearch release
* is "too old" or "too new." The static {@link #current()} method returns
* the current release version, and {@link #fromVersionId(int)} returns
* a version based on some identifier. By default, this identifier matches
* what the {@link Version} class uses, but the implementation is pluggable.
* is "too old" or "too new," using an intentionally minimal API for
* comparisons. The static {@link #current()} method returns the current
* release version, and {@link #fromVersionId(int)} returns a version
* based on some identifier. By default, this identifier matches what the
* {@link Version} class uses, but the implementation is pluggable.
* If a module provides a {@link BuildExtension} service via Java SPI, this
* class's static methods will return a different implementation of {@link BuildVersion},
* potentially with different behavior. This allows downstream projects to
Expand Down

0 comments on commit 3daa19c

Please sign in to comment.