blob: 6e74a7c2675e5396ddd6adb92015accf4a920b91 [file] [log] [blame]
Matthias Andreas Benkardb5d657a2022-02-03 21:14:30 +01001// SPDX-FileCopyrightText: © 2021 Matthias Andreas Benkard <code@mail.matthias.benkard.de>
2//
3// SPDX-License-Identifier: LGPL-3.0-or-later
4
Matthias Andreas Benkard4c32c392021-12-12 21:23:53 +01005/**
6 * Provides a parser for the <a href="https://docs.gtk.org/glib/struct.Variant.html">GVariant</a>
7 * serialization format.
8 *
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +01009 * <ul>
10 * <li><a href="#sect-overview">Overview</a>
11 * <li><a href="#sect-installation">Installation</a>
12 * </ul>
13 *
14 * <h2 id="sect-overview">Overview</h2>
15 *
Matthias Andreas Benkard55c34812021-12-14 21:51:10 +010016 * <p>The {@link eu.mulk.jgvariant.core} package contains the {@link eu.mulk.jgvariant.core.Decoder}
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +010017 * type, which contains classes to parse and represent serialized <a
18 * href="https://docs.gtk.org/glib/struct.Variant.html">GVariant</a> values.
19 *
20 * <h2 id="sect-installation">Installation</h2>
21 *
22 * <ul>
23 * <li><a href="#sect-installation-maven">Usage with Maven</a>
24 * <li><a href="#sect-installation-gradle">Usage with Gradle</a>
25 * </ul>
26 *
27 * <h3 id="sect-installation-maven">Usage with Maven</h3>
28 *
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020029 * {@snippet lang="xml" :
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +010030 * <project>
31 * ...
32 *
Matthias Andreas Benkard796b19d2021-12-18 23:38:46 +010033 * <dependencyManagement>
34 * ...
35 *
36 * <dependencies>
37 * <dependency>
38 * <groupId>eu.mulk.jgvariant</groupId>
39 * <artifactId>jgvariant-bom</artifactId>
Matthias Andreas Benkard52504582022-10-09 19:37:56 +020040 * <version>0.1.7</version>
Matthias Andreas Benkard796b19d2021-12-18 23:38:46 +010041 * <type>pom</type>
42 * <scope>import</scope>
43 * </dependency>
44 * </dependencies>
45 *
46 * ...
47 * </dependencyManagement>
48 *
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +010049 * <dependencies>
50 * ...
51 *
52 * <dependency>
53 * <groupId>eu.mulk.jgvariant</groupId>
54 * <artifactId>jgvariant-core</artifactId>
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +010055 * </dependency>
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010056 * <dependency>
57 * <groupId>eu.mulk.jgvariant</groupId>
58 * <artifactId>jgvariant-ostree</artifactId>
59 * </dependency>
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +010060 *
61 * ...
62 * </dependencies>
63 *
64 * ...
65 * </project>
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020066 * }
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +010067 *
68 * <h3 id="sect-installation-gradle">Usage with Gradle</h3>
69 *
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020070 * {@snippet lang="groovy" :
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +010071 * dependencies {
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020072 * // ...
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +010073 *
Matthias Andreas Benkard52504582022-10-09 19:37:56 +020074 * implementation(platform("eu.mulk.jgvariant:jgvariant-bom:0.1.7"))
Matthias Andreas Benkard796b19d2021-12-18 23:38:46 +010075 * implementation("eu.mulk.jgvariant:jgvariant-core")
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010076 * implementation("eu.mulk.jgvariant:jgvariant-ostree")
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +010077 *
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020078 * // ...
Matthias Andreas Benkard8bbc9c12021-12-18 22:57:27 +010079 * }
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020080 * }
Matthias Andreas Benkard4c32c392021-12-12 21:23:53 +010081 */
Matthias Andreas Benkard261532a2021-12-12 20:09:27 +010082module eu.mulk.jgvariant.core {
Matthias Andreas Benkarde0022372022-10-09 19:32:25 +020083 requires static com.google.errorprone.annotations;
84 requires static org.apiguardian.api;
85 requires static org.jetbrains.annotations;
Matthias Andreas Benkard261532a2021-12-12 20:09:27 +010086
87 exports eu.mulk.jgvariant.core;
88}