aboutsummaryrefslogtreecommitdiff
path: root/jgvariant-core/src/main/java/module-info.java
diff options
context:
space:
mode:
authorMatthias Andreas Benkard <code@mail.matthias.benkard.de>2021-12-18 23:38:46 +0100
committerMatthias Andreas Benkard <code@mail.matthias.benkard.de>2021-12-18 23:38:46 +0100
commit796b19da1b9ef6c1721faa2ddf35100eb01a8a28 (patch)
tree44c4edf40e73b11d09535d011de95be71d0fdec0 /jgvariant-core/src/main/java/module-info.java
parent8bbc9c1a04177dc0bc0082cc59d98d57eead4c1f (diff)
POM: Split into -bom, -core, -parent, -bundle.
Change-Id: I1fd4cc766b60266ef9dcc40e943b45d067dd7b90
Diffstat (limited to 'jgvariant-core/src/main/java/module-info.java')
-rw-r--r--jgvariant-core/src/main/java/module-info.java79
1 files changed, 79 insertions, 0 deletions
diff --git a/jgvariant-core/src/main/java/module-info.java b/jgvariant-core/src/main/java/module-info.java
new file mode 100644
index 0000000..a1830f6
--- /dev/null
+++ b/jgvariant-core/src/main/java/module-info.java
@@ -0,0 +1,79 @@
+/**
+ * Provides a parser for the <a href="https://docs.gtk.org/glib/struct.Variant.html">GVariant</a>
+ * serialization format.
+ *
+ * <ul>
+ * <li><a href="#sect-overview">Overview</a>
+ * <li><a href="#sect-installation">Installation</a>
+ * </ul>
+ *
+ * <h2 id="sect-overview">Overview</h2>
+ *
+ * <p>The {@link eu.mulk.jgvariant.core} package contains the {@link eu.mulk.jgvariant.core.Decoder}
+ * type, which contains classes to parse and represent serialized <a
+ * href="https://docs.gtk.org/glib/struct.Variant.html">GVariant</a> values.
+ *
+ * <h2 id="sect-installation">Installation</h2>
+ *
+ * <ul>
+ * <li><a href="#sect-installation-maven">Usage with Maven</a>
+ * <li><a href="#sect-installation-gradle">Usage with Gradle</a>
+ * </ul>
+ *
+ * <h3 id="sect-installation-maven">Usage with Maven</h3>
+ *
+ * <pre>{@code
+ * <project>
+ * ...
+ *
+ * <dependencyManagement>
+ * ...
+ *
+ * <dependencies>
+ * <dependency>
+ * <groupId>eu.mulk.jgvariant</groupId>
+ * <artifactId>jgvariant-bom</artifactId>
+ * <version>0.1.4</version>
+ * <type>pom</type>
+ * <scope>import</scope>
+ * </dependency>
+ * </dependencies>
+ *
+ * ...
+ * </dependencyManagement>
+ *
+ * <dependencies>
+ * ...
+ *
+ * <dependency>
+ * <groupId>eu.mulk.jgvariant</groupId>
+ * <artifactId>jgvariant-core</artifactId>
+ * </dependency>
+ *
+ * ...
+ * </dependencies>
+ *
+ * ...
+ * </project>
+ * }</pre>
+ *
+ * <h3 id="sect-installation-gradle">Usage with Gradle</h3>
+ *
+ * <pre>{@code
+ * dependencies {
+ * ...
+ *
+ * implementation(platform("eu.mulk.jgvariant:jgvariant-bom:0.1.4")
+ * implementation("eu.mulk.jgvariant:jgvariant-core")
+ *
+ * ...
+ * }
+ * }</pre>
+ */
+module eu.mulk.jgvariant.core {
+ requires com.google.errorprone.annotations;
+ requires org.jetbrains.annotations;
+ requires org.apiguardian.api;
+
+ exports eu.mulk.jgvariant.core;
+}