blob: e51c586b124125ca6558335c132cfa4648a4684b [file] [log] [blame]
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +01001/**
2 * Provides a parser for the <a href="https://docs.gtk.org/glib/struct.Variant.html">GVariant</a>
3 * serialization format.
4 *
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 *
12 * <p>The {@link eu.mulk.jgvariant.ostree} package contains record classes describing the elements
13 * of <a href="https://ostreedev.github.io/ostree/">OSTree</a> repositories and factory methods to
14 * create {@link eu.mulk.jgvariant.core.Decoder} instances for them.
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 *
29 * <dependencyManagement>
30 * ...
31 *
32 * <dependencies>
33 * <dependency>
34 * <groupId>eu.mulk.jgvariant</groupId>
35 * <artifactId>jgvariant-bom</artifactId>
36 * <version>0.1.4</version>
37 * <type>pom</type>
38 * <scope>import</scope>
39 * </dependency>
40 * </dependencies>
41 *
42 * ...
43 * </dependencyManagement>
44 *
45 * <dependencies>
46 * ...
47 *
48 * <dependency>
49 * <groupId>eu.mulk.jgvariant</groupId>
50 * <artifactId>jgvariant-core</artifactId>
51 * </dependency>
52 * <dependency>
53 * <groupId>eu.mulk.jgvariant</groupId>
54 * <artifactId>jgvariant-ostree</artifactId>
55 * </dependency>
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 *
70 * implementation(platform("eu.mulk.jgvariant:jgvariant-bom:0.1.4")
71 * implementation("eu.mulk.jgvariant:jgvariant-core")
72 * implementation("eu.mulk.jgvariant:jgvariant-ostree")
73 *
74 * ...
75 * }
76 * }</pre>
77 */
78module eu.mulk.jgvariant.gvariant {
79 requires transitive eu.mulk.jgvariant.core;
80 requires com.google.errorprone.annotations;
81 requires org.jetbrains.annotations;
82 requires org.apiguardian.api;
83
84 exports eu.mulk.jgvariant.ostree;
85}