aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/module-info.java
diff options
context:
space:
mode:
authorMatthias Andreas Benkard <code@mail.matthias.benkard.de>2021-12-12 21:23:53 +0100
committerMatthias Andreas Benkard <code@mail.matthias.benkard.de>2021-12-12 21:23:53 +0100
commit4c32c3998476e12c34984d52253eaa4ae3bf6769 (patch)
tree62787608ad6caa5aef974d6a96da24cebbb21667 /src/main/java/module-info.java
parent261532a25244be9562700aa95a91c1c71adb8405 (diff)
Javadocs and README.
Change-Id: I10d7cb87ca22475f3f73fb25acd813aa1f8d2bb8
Diffstat (limited to 'src/main/java/module-info.java')
-rw-r--r--src/main/java/module-info.java8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java
index 8880c0b..403cf1f 100644
--- a/src/main/java/module-info.java
+++ b/src/main/java/module-info.java
@@ -1,5 +1,11 @@
+/**
+ * Provides a parser for the <a href="https://docs.gtk.org/glib/struct.Variant.html">GVariant</a>
+ * serialization format.
+ *
+ * <p>The {@link eu.mulk.jgvariant.core} package contains the {@link eu.mulk.jgvariant.core.Value}
+ * and {@link eu.mulk.jgvariant.core.Decoder} types. which form the foundation of this library.
+ */
module eu.mulk.jgvariant.core {
- requires java.base;
requires com.google.errorprone.annotations;
requires org.jetbrains.annotations;