From b50fcd05c0f6701bcddfebff5689a34a76534fab Mon Sep 17 00:00:00 2001 From: Matthias Andreas Benkard Date: Thu, 16 Dec 2021 20:17:20 +0100 Subject: Improve Variant documentation. Change-Id: Ic25729c8bf2e71cdfcf54e3a2794664b400723bd --- src/main/java/eu/mulk/jgvariant/core/Decoder.java | 7 ++++--- src/main/java/eu/mulk/jgvariant/core/Variant.java | 3 ++- 2 files changed, 6 insertions(+), 4 deletions(-) (limited to 'src/main/java') 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 @@ public abstract class Decoder { } /** - * Creates a {@link Decoder} for the {@code Variant} type. + * Creates a {@link Decoder} for the {@link Variant} type. * - *

The returned {@link Object} can be of one of the following types: + *

The contained {@link Object} can be of one of the following types: * *

* * @return a new {@link Decoder}. @@ -164,7 +165,7 @@ public abstract class Decoder { } /** - * 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 @@ package eu.mulk.jgvariant.core; *
  • {@link java.util.Optional} (a GVariant {@code Maybe} type) *
  • {@link java.util.List} (a GVariant array) *
  • {@link Object[]} (a GVariant structure) + *
  • {@link Variant} (a nested variant) * * * @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) {} -- cgit v1.2.3