blob: 0282ff8fbdb1d63780eb08e0b9c3000460c6325f [file] [log] [blame]
Matthias Andreas Benkard4c32c392021-12-12 21:23:53 +01001/**
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 +01005 * <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 +010012 * <p>The {@link eu.mulk.jgvariant.core} package contains the {@link eu.mulk.jgvariant.core.Decoder}
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +010013 * 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 *
29 * <dependencies>
30 * ...
31 *
32 * <dependency>
33 * <groupId>eu.mulk.jgvariant</groupId>
34 * <artifactId>jgvariant-core</artifactId>
35 * <version>0.1.3</version>
36 * </dependency>
37 *
38 * ...
39 * </dependencies>
40 *
41 * ...
42 * </project>
43 * }</pre>
44 *
45 * <h3 id="sect-installation-gradle">Usage with Gradle</h3>
46 *
47 * <pre>{@code
48 * dependencies {
49 * ...
50 *
51 * implementation("eu.mulk.jgvariant:jgvariant-core:0.1.3")
52 *
53 * ...
54 * }
55 * }</pre>
Matthias Andreas Benkard4c32c392021-12-12 21:23:53 +010056 */
Matthias Andreas Benkard261532a2021-12-12 20:09:27 +010057module eu.mulk.jgvariant.core {
Matthias Andreas Benkard261532a2021-12-12 20:09:27 +010058 requires com.google.errorprone.annotations;
59 requires org.jetbrains.annotations;
Matthias Andreas Benkard25b7f902021-12-17 06:02:11 +010060 requires org.apiguardian.api;
Matthias Andreas Benkard261532a2021-12-12 20:09:27 +010061
62 exports eu.mulk.jgvariant.core;
63}