blob: 59b458f595e0ab8815f3eeec412b0df2cd2df0c7 [file] [log] [blame]
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +01001/**
Matthias Andreas Benkardaa294842021-12-28 01:31:56 +01002 * {@link eu.mulk.jgvariant.core.Decoder} instances for OSTree repositories.
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +01003 *
4 * <ul>
5 * <li><a href="#sect-overview">Overview</a>
6 * <li><a href="#sect-installation">Installation</a>
7 * </ul>
8 *
9 * <h2 id="sect-overview">Overview</h2>
10 *
11 * <p>The {@link eu.mulk.jgvariant.ostree} package contains record classes describing the elements
12 * of <a href="https://ostreedev.github.io/ostree/">OSTree</a> repositories and factory methods to
13 * create {@link eu.mulk.jgvariant.core.Decoder} instances for them.
14 *
15 * <h2 id="sect-installation">Installation</h2>
16 *
17 * <ul>
18 * <li><a href="#sect-installation-maven">Usage with Maven</a>
19 * <li><a href="#sect-installation-gradle">Usage with Gradle</a>
20 * </ul>
21 *
22 * <h3 id="sect-installation-maven">Usage with Maven</h3>
23 *
24 * <pre>{@code
25 * <project>
26 * ...
27 *
28 * <dependencyManagement>
29 * ...
30 *
31 * <dependencies>
32 * <dependency>
33 * <groupId>eu.mulk.jgvariant</groupId>
34 * <artifactId>jgvariant-bom</artifactId>
35 * <version>0.1.4</version>
36 * <type>pom</type>
37 * <scope>import</scope>
38 * </dependency>
39 * </dependencies>
40 *
41 * ...
42 * </dependencyManagement>
43 *
44 * <dependencies>
45 * ...
46 *
47 * <dependency>
48 * <groupId>eu.mulk.jgvariant</groupId>
49 * <artifactId>jgvariant-core</artifactId>
50 * </dependency>
51 * <dependency>
52 * <groupId>eu.mulk.jgvariant</groupId>
53 * <artifactId>jgvariant-ostree</artifactId>
54 * </dependency>
55 *
56 * ...
57 * </dependencies>
58 *
59 * ...
60 * </project>
61 * }</pre>
62 *
63 * <h3 id="sect-installation-gradle">Usage with Gradle</h3>
64 *
65 * <pre>{@code
66 * dependencies {
67 * ...
68 *
69 * implementation(platform("eu.mulk.jgvariant:jgvariant-bom:0.1.4")
70 * implementation("eu.mulk.jgvariant:jgvariant-core")
71 * implementation("eu.mulk.jgvariant:jgvariant-ostree")
72 *
73 * ...
74 * }
75 * }</pre>
76 */
Matthias Andreas Benkarda7e9d522021-12-28 01:37:47 +010077module eu.mulk.jgvariant.ostree {
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010078 requires transitive eu.mulk.jgvariant.core;
79 requires com.google.errorprone.annotations;
80 requires org.jetbrains.annotations;
81 requires org.apiguardian.api;
82
83 exports eu.mulk.jgvariant.ostree;
84}