Improve Variant documentation.
Change-Id: Ic25729c8bf2e71cdfcf54e3a2794664b400723bd
diff --git a/src/main/java/eu/mulk/jgvariant/core/Decoder.java b/src/main/java/eu/mulk/jgvariant/core/Decoder.java
index 389ae85..d0c0323 100644
--- a/src/main/java/eu/mulk/jgvariant/core/Decoder.java
+++ b/src/main/java/eu/mulk/jgvariant/core/Decoder.java
@@ -141,9 +141,9 @@
}
/**
- * Creates a {@link Decoder} for the {@code Variant} type.
+ * Creates a {@link Decoder} for the {@link Variant} type.
*
- * <p>The returned {@link Object} can be of one of the following types:
+ * <p>The contained {@link Object} can be of one of the following types:
*
* <ul>
* <li>{@link Boolean}
@@ -155,6 +155,7 @@
* <li>{@link Optional} (a GVariant {@code Maybe} type)
* <li>{@link List} (a GVariant array)
* <li>{@link Object[]} (a GVariant structure)
+ * <li>{@link Variant} (a nested variant)
* </ul>
*
* @return a new {@link Decoder}.
@@ -164,7 +165,7 @@
}
/**
- * Creates a {@link Decoder} for the {@code Boolean} type.
+ * Creates a {@link Decoder} for the {@code boolean} type.
*
* @return a new {@link Decoder}.
*/
diff --git a/src/main/java/eu/mulk/jgvariant/core/Variant.java b/src/main/java/eu/mulk/jgvariant/core/Variant.java
index e2b4b68..134a5e8 100644
--- a/src/main/java/eu/mulk/jgvariant/core/Variant.java
+++ b/src/main/java/eu/mulk/jgvariant/core/Variant.java
@@ -15,11 +15,12 @@
* <li>{@link java.util.Optional} (a GVariant {@code Maybe} type)
* <li>{@link java.util.List} (a GVariant array)
* <li>{@link Object[]} (a GVariant structure)
+ * <li>{@link Variant} (a nested variant)
* </ul>
*
* @param signature the signature describing the type of the value.
* @param value the value itself; one of {@link Boolean}, {@link Byte}, {@link Short}, {@link
* Integer}, {@link Long}, {@link String}, {@link java.util.Optional}, {@link java.util.List},
- * {@link Object[]}.
+ * {@link Object[]}, {@link Variant}.
*/
public record Variant(Signature signature, Object value) {}