blob: 50324d8424268f37d9345603181ba68b40410ac4 [file] [log] [blame]
// SPDX-FileCopyrightText: © 2021 Matthias Andreas Benkard <code@mail.matthias.benkard.de>
//
// SPDX-License-Identifier: LGPL-3.0-or-later
import org.jspecify.annotations.NullMarked;
/**
* {@link eu.mulk.jgvariant.core.Decoder} instances for OSTree repositories.
*
* <ul>
* <li><a href="#sect-overview">Overview</a>
* <li><a href="#sect-installation">Installation</a>
* </ul>
*
* <h2 id="sect-overview">Overview</h2>
*
* <p>The {@link eu.mulk.jgvariant.ostree} package contains record classes describing the elements
* of <a href="https://ostreedev.github.io/ostree/">OSTree</a> repositories and factory methods to
* create {@link eu.mulk.jgvariant.core.Decoder} instances for them.
*
* <h2 id="sect-installation">Installation</h2>
*
* <ul>
* <li><a href="#sect-installation-maven">Usage with Maven</a>
* <li><a href="#sect-installation-gradle">Usage with Gradle</a>
* </ul>
*
* <h3 id="sect-installation-maven">Usage with Maven</h3>
*
* {@snippet lang="xml" :
* <project>
* ...
*
* <dependencyManagement>
* ...
*
* <dependencies>
* <dependency>
* <groupId>eu.mulk.jgvariant</groupId>
* <artifactId>jgvariant-bom</artifactId>
* <version>0.1.10</version>
* <type>pom</type>
* <scope>import</scope>
* </dependency>
* </dependencies>
*
* ...
* </dependencyManagement>
*
* <dependencies>
* ...
*
* <dependency>
* <groupId>eu.mulk.jgvariant</groupId>
* <artifactId>jgvariant-core</artifactId>
* </dependency>
* <dependency>
* <groupId>eu.mulk.jgvariant</groupId>
* <artifactId>jgvariant-ostree</artifactId>
* </dependency>
*
* ...
* </dependencies>
*
* ...
* </project>
* }
*
* <h3 id="sect-installation-gradle">Usage with Gradle</h3>
*
* {@snippet lang="groovy" :
* dependencies {
* // ...
*
* implementation(platform("eu.mulk.jgvariant:jgvariant-bom:0.1.10"))
* implementation("eu.mulk.jgvariant:jgvariant-core")
* implementation("eu.mulk.jgvariant:jgvariant-ostree")
*
* // ...
* }
* }
*/
@NullMarked
module eu.mulk.jgvariant.ostree {
requires transitive eu.mulk.jgvariant.core;
requires org.tukaani.xz;
requires static com.google.errorprone.annotations;
requires static org.apiguardian.api;
requires static org.jspecify;
exports eu.mulk.jgvariant.ostree;
}