ao-javadoc-offline

Used in 1 component

pkg:maven/com.aoapps/ao-javadoc-offline@3.5.0

Overview
Overview

Versions
Versions

Dependents
Dependents

Dependencies
Dependencies

Overview

Description

A bundle of Javadoc element-list and package-list files supporting offline builds.

Snippets

<dependency>
    <groupId>com.aoapps</groupId>
    <artifactId>ao-javadoc-offline</artifactId>
    <version>3.5.0</version>
</dependency>

Maven POM File

<?xml version="1.0" encoding="UTF-8"?>
<!--
ao-javadoc-offline - A bundle of Javadoc element-list and package-list files supporting offline builds.
Copyright (C) 2020, 2021, 2022, 2023, 2024  AO Industries, Inc.
    support@aoindustries.com
    7262 Bull Pen Cir
    Mobile, AL 36695

This file is part of ao-javadoc-offline.

ao-javadoc-offline is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

ao-javadoc-offline is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with ao-javadoc-offline.  If not, see <https://www.gnu.org/licenses/>.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>com.aoapps</groupId><artifactId>ao-oss-parent</artifactId><version>1.24.3<!-- -POST-SNAPSHOT --></version>
    <relativePath>../parent/pom.xml</relativePath>
  </parent>

  <groupId>com.aoapps</groupId><artifactId>ao-javadoc-offline</artifactId><version>3.5.0</version>
  <packaging>jar</packaging>

  <properties>
    <!-- Must be set to ${git.commit.time} for snapshots or ISO 8601 timestamp for releases. -->
    <project.build.outputTimestamp>2024-05-08T01:50:08Z</project.build.outputTimestamp>
    <module.name>com.aoapps.javadoc.offline</module.name>
    <!-- Java 11 inherited from parent -->
    <!-- Matches "requireJavaVersion" from ao-oss-parent -->
  </properties>

  <name>AO Javadoc Offline</name>
  <url>https://oss.aoapps.com/javadoc-offline/</url>
  <description>A bundle of Javadoc element-list and package-list files supporting offline builds.</description>
  <inceptionYear>2020</inceptionYear>

  <licenses>
    <license>
      <name>GNU General Lesser Public License (LGPL) version 3.0</name>
      <url>https://www.gnu.org/licenses/lgpl-3.0.txt</url>
      <distribution>repo</distribution>
    </license>
  </licenses>

  <organization>
    <name>AO Industries, Inc.</name>
    <url>https://aoindustries.com/</url>
  </organization>

  <developers>
    <developer>
      <name>AO Industries, Inc.</name>
      <email>support@aoindustries.com</email>
      <url>https://aoindustries.com/</url>
      <organization>AO Industries, Inc.</organization>
      <organizationUrl>https://aoindustries.com/</organizationUrl>
    </developer>
  </developers>

  <scm>
    <connection>scm:git:git://github.com/ao-apps/ao-javadoc-offline.git</connection>
    <developerConnection>scm:git:git@github.com:ao-apps/ao-javadoc-offline.git</developerConnection>
    <url>https://github.com/ao-apps/ao-javadoc-offline</url>
    <tag>ao-javadoc-offline-3.5.0</tag>
  </scm>

  <issueManagement>
    <system>GitHub Issues</system>
    <url>https://github.com/ao-apps/ao-javadoc-offline/issues</url>
  </issueManagement>

  <ciManagement>
    <system>Jenkins</system>
    <url>https://jenkins.aoindustries.com/job/ao/job/oss/job/javadoc-offline/</url>
  </ciManagement>
  <!-- Only one allowed in POM:
  <ciManagement>
    <system>GitHub Actions</system>
    <url>https://github.com/ao-apps/ao-javadoc-offline/actions</url>
  </ciManagement>
  -->

  <repositories>
    <!-- Repository required here, too, so can find parent -->
    <repository>
      <id>sonatype-nexus-snapshots-s01</id>
      <name>Sonatype Nexus Snapshots S01</name>
      <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
      <releases>
        <enabled>false</enabled>
      </releases>
      <snapshots>
        <checksumPolicy>fail</checksumPolicy>
      </snapshots>
    </repository>
  </repositories>

  <build>
    <!--
      module-info.java moved to src/main/java-11, since chicken-and-egg issue activated in parent when
      src/main/java is present.  The parent adds ao-javadoc-offline as a plugin dependency.  This, in-turn,
      will attempt to fetch the dependency, not using this version from the reactor build.  This may cause the
      build to fail when switching to a new version of ao-javadoc-offline.
    -->
    <sourceDirectory>src/main/java-11</sourceDirectory>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId><artifactId>maven-remote-resources-plugin</artifactId>
        <executions>
          <execution>
            <!-- Done at generate-sources so is before javadoc:javadoc -->
            <id>bundle.offlineLinks</id><phase>generate-sources</phase><goals><goal>bundle</goal></goals>
          </execution>
        </executions>
        <configuration>
          <includes>
            <include>**/element-list</include><!-- Java >= 10 -->
            <include>**/package-list</include><!-- Java <= 9 -->
          </includes>
          <outputDirectory>${project.build.directory}/generated-resources</outputDirectory>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>