[jOOQ/jOOQ#9506] Some better Javadocs

This commit is contained in:
Lukas Eder 2023-06-22 09:30:36 +02:00
parent 3e6fd534fa
commit 7bb57342dd
2 changed files with 11 additions and 1 deletions

View File

@ -43,7 +43,9 @@ import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.ApiStatus.Experimental;
/**
* A commit in a version control system.
* A change set describing the exact migration path between the
* {@link #parents()} versions and the {@link #version()} represented by this
* change.
*
* @author Lukas Eder
*/

View File

@ -48,6 +48,14 @@ import org.jetbrains.annotations.ApiStatus.Experimental;
/**
* A version ID attached to a {@link Meta} description of a database.
* <p>
* Unlike a {@link Commit}, which describes a <em>change</em> between two
* versions of a database, this type just describes the version itself, not how
* to get to the version.
* <p>
* While it is possible to describe a path between versions using a migration
* (e.g. composed of {@link Queries}), the versions themselves do not expose
* this information.
* <p>
* This is EXPERIMENTAL functionality and subject to change in future jOOQ
* versions.
*