Gitiles
Code Review Sign In
gerrit.benkard.de / jgvariant / 33d9ffa3bf5ebeb3c655266bb99c9133b977c39b / . / jgvariant-core / src / main / java / module-info.java
blob: ab5730ec7eb70f9fd8dd630c9b76876d22b42bbc [file] [log] [blame]
Matthias Andreas Benkard4c32c392021-12-12 21:23:53 +0100[diff] [blame]1/**
2 * Provides a parser for the <a href="https://docs.gtk.org/glib/struct.Variant.html">GVariant</a>
3 * serialization format.
4 *
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +0100[diff] [blame]5 * <ul>
6 * <li><a href="#sect-overview">Overview</a>
7 * <li><a href="#sect-installation">Installation</a>
8 * </ul>
9 *
10 * <h2 id="sect-overview">Overview</h2>
11 *
Matthias Andreas Benkard55c34812021-12-14 21:51:10 +0100[diff] [blame]12 * <p>The {@link eu.mulk.jgvariant.core} package contains the {@link eu.mulk.jgvariant.core.Decoder}
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +0100[diff] [blame]13 * type, which contains classes to parse and represent serialized <a
14 * href="https://docs.gtk.org/glib/struct.Variant.html">GVariant</a> values.
15 *
16 * <h2 id="sect-installation">Installation</h2>
17 *
18 * <ul>
19 * <li><a href="#sect-installation-maven">Usage with Maven</a>
20 * <li><a href="#sect-installation-gradle">Usage with Gradle</a>
21 * </ul>
22 *
23 * <h3 id="sect-installation-maven">Usage with Maven</h3>
24 *
25 * <pre>{@code
26 * <project>
27 * ...
28 *
Matthias Andreas Benkard796b19d2021-12-18 23:38:46 +0100[diff] [blame]29 * <dependencyManagement>
30 * ...
31 *
32 * <dependencies>
33 * <dependency>
34 * <groupId>eu.mulk.jgvariant</groupId>
35 * <artifactId>jgvariant-bom</artifactId>
Matthias Andreas Benkard2db188d2021-12-30 21:07:52 +0100[diff] [blame]36 * <version>0.1.5</version>
Matthias Andreas Benkard796b19d2021-12-18 23:38:46 +0100[diff] [blame]37 * <type>pom</type>
38 * <scope>import</scope>
39 * </dependency>
40 * </dependencies>
41 *
42 * ...
43 * </dependencyManagement>
44 *
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +0100[diff] [blame]45 * <dependencies>
46 * ...
47 *
48 * <dependency>
49 * <groupId>eu.mulk.jgvariant</groupId>
50 * <artifactId>jgvariant-core</artifactId>
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +0100[diff] [blame]51 * </dependency>
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +0100[diff] [blame]52 * <dependency>
53 * <groupId>eu.mulk.jgvariant</groupId>
54 * <artifactId>jgvariant-ostree</artifactId>
55 * </dependency>
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +0100[diff] [blame]56 *
57 * ...
58 * </dependencies>
59 *
60 * ...
61 * </project>
62 * }</pre>
63 *
64 * <h3 id="sect-installation-gradle">Usage with Gradle</h3>
65 *
66 * <pre>{@code
67 * dependencies {
68 * ...
69 *
Matthias Andreas Benkard2db188d2021-12-30 21:07:52 +0100[diff] [blame]70 * implementation(platform("eu.mulk.jgvariant:jgvariant-bom:0.1.5")
Matthias Andreas Benkard796b19d2021-12-18 23:38:46 +0100[diff] [blame]71 * implementation("eu.mulk.jgvariant:jgvariant-core")
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +0100[diff] [blame]72 * implementation("eu.mulk.jgvariant:jgvariant-ostree")
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +0100[diff] [blame]73 *
74 * ...
75 * }
76 * }</pre>
Matthias Andreas Benkard4c32c392021-12-12 21:23:53 +0100[diff] [blame]77 */
Matthias Andreas Benkard261532a2021-12-12 20:09:27 +0100[diff] [blame]78module eu.mulk.jgvariant.core {
Matthias Andreas Benkard261532a2021-12-12 20:09:27 +0100[diff] [blame]79 requires com.google.errorprone.annotations;
80 requires org.jetbrains.annotations;
Matthias Andreas Benkard25b7f902021-12-17 06:02:11 +0100[diff] [blame]81 requires org.apiguardian.api;
Matthias Andreas Benkard261532a2021-12-12 20:09:27 +0100[diff] [blame]82
83 exports eu.mulk.jgvariant.core;
84}