Skip to content

ARIES-2240: Configure javadoc generation in build lifecycle from parent #877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alien11689 merged 2 commits into from
Aug 7, 2026
Merged

ARIES-2240: Configure javadoc generation in build lifecycle from parent #877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff13426
ARIES-2240: Configure javadoc in parent as for site
alien11689 Aug 5, 2026
53f6600
ARIES-2240: Configure new parent with javadoc in util, testsupport an…
alien11689 Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 68 additions & 2 deletions parent/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,73 @@
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<source>${java.source.version}</source>
<quiet>true</quiet>
<excludePackageNames>${aries.javadoc.exclude.packages}</excludePackageNames>
<!--
External links are deliberately omitted here: javadoc would fetch the
referenced package-list/element-list files on every invocation, making
the build dependent on network access. External API links are only
configured for the generated site (reporting section below).
-->
<tags>
<tag>
<name>goal</name>
<placement>Xt</placement>
</tag>
<tag>
<name>phase</name>
<placement>Xt</placement>
</tag>
<tag>
<name>execute</name>
<placement>Xt</placement>
</tag>
<tag>
<name>requiresDependencyResolution</name>
<placement>Xt</placement>
</tag>
<tag>
<name>parameter</name>
<placement>Xf</placement>
</tag>
<tag>
<name>required</name>
<placement>Xf</placement>
</tag>
<tag>
<name>readonly</name>
<placement>Xf</placement>
</tag>
<tag>
<name>component</name>
<placement>Xf</placement>
</tag>
<tag>
<name>plexus.component</name>
<placement>Xf</placement>
</tag>
<tag>
<name>plexus.requirement</name>
<placement>Xf</placement>
</tag>
<tag>
<name>Immutable</name>
<placement>t</placement>
</tag>
<tag>
<name>ThreadSafe</name>
<placement>t</placement>
</tag>
</tags>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.rat</groupId>
Expand Down Expand Up @@ -554,8 +620,8 @@
<quiet>true</quiet>
<source>${java.source.version}</source>
<links>
<link>http://java.sun.com/j2se/1.7.0/docs/api</link>
<link>http://www.osgi.org/javadoc/r4v43/</link>
<link>https://docs.osgi.org/javadoc/r4v43/core/</link>
<link>https://docs.osgi.org/javadoc/r4v43/cmpn/</link>
</links>
<tags>
<tag>
Expand Down
2 changes: 1 addition & 1 deletion testsupport/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<parent>
<groupId>org.apache.aries</groupId>
<artifactId>parent</artifactId>
<version>3.1.0</version>
<version>3.1.1-SNAPSHOT</version>
<relativePath>../parent/pom.xml</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion testsupport/testsupport-unit/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<parent>
<groupId>org.apache.aries</groupId>
<artifactId>parent</artifactId>
<version>3.1.0</version>
<version>3.1.1-SNAPSHOT</version>
<relativePath>../../parent/pom.xml</relativePath>
</parent>

Expand Down
25 changes: 2 additions & 23 deletions util/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<parent>
<groupId>org.apache.aries</groupId>
<artifactId>parent</artifactId>
<version>3.1.0</version>
<version>3.1.1-SNAPSHOT</version>
<relativePath>../parent/pom.xml</relativePath>
</parent>

Expand Down Expand Up @@ -66,7 +66,7 @@
<aries.skip.version.check>true</aries.skip.version.check>
<org.apache.aries.versioning.plugin.version>0.3.1</org.apache.aries.versioning.plugin.version>

<maven-javadoc-plugin.version>3.12.0</maven-javadoc-plugin.version>
<aries.javadoc.exclude.packages>${aries.osgi.private.pkg}</aries.javadoc.exclude.packages>
<org.apache.aries.testsupport.unit.version>2.0.0</org.apache.aries.testsupport.unit.version>
<org.eclipse.osgi.version>3.23.100</org.eclipse.osgi.version>
</properties>
Expand Down Expand Up @@ -101,25 +101,4 @@
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<executions>
<execution>
<id>javadoc-jar</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<failOnError>false</failOnError>
<excludePackageNames>*.impl:*.internal</excludePackageNames>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
2 changes: 1 addition & 1 deletion util/src/main/java/org/apache/aries/util/log/Logger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
// Note this file originated in the JMX subproject.

/**
* <p>This <tt>Logger</tt> class represents ServiceTracker for LogService.
* <p>This <code>Logger</code> class represents ServiceTracker for LogService.
* It provides a simple mechanism for interacting with the log service.
*
* @see org.osgi.service.log.LogService
Expand Down
2 changes: 1 addition & 1 deletion versioning/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<parent>
<groupId>org.apache.aries</groupId>
<artifactId>parent</artifactId>
<version>3.1.0</version>
<version>3.1.1-SNAPSHOT</version>
<relativePath>../parent/pom.xml</relativePath>
</parent>

Expand Down
3 changes: 2 additions & 1 deletion versioning/versioning-checker/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<parent>
<groupId>org.apache.aries</groupId>
<artifactId>parent</artifactId>
<version>3.1.0</version>
<version>3.1.1-SNAPSHOT</version>
<relativePath>../../parent/pom.xml</relativePath>
</parent>

Expand Down Expand Up @@ -57,6 +57,7 @@
<aries.osgi.private.pkg>
org.apache.aries.versioning.utils;
</aries.osgi.private.pkg>
<aries.javadoc.exclude.packages>org.apache.aries.versioning.utils</aries.javadoc.exclude.packages>
<lastReleaseVersion>0.4.0</lastReleaseVersion>
<aries.skip.version.check>true</aries.skip.version.check>

Expand Down
3 changes: 0 additions & 3 deletions ...rsioning-checker/src/main/java/org/apache/aries/versioning/check/BundleCompatibility.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,6 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
* @version $Rev:$ $Date:$
*/
public class BundleCompatibility {
private static final Logger _logger = LoggerFactory.getLogger(BundleCompatibility.class);

Expand Down
3 changes: 0 additions & 3 deletions ...ioning/versioning-checker/src/main/java/org/apache/aries/versioning/check/BundleInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@

import org.apache.aries.util.manifest.BundleManifest;

/**
* @version $Rev:$ $Date:$
*/
public class BundleInfo {
private final BundleManifest bundleManifest;
private final File bundle;
Expand Down
3 changes: 0 additions & 3 deletions ...ing/versioning-checker/src/main/java/org/apache/aries/versioning/check/VersionChange.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,6 @@

import org.osgi.framework.Version;

/**
* @version $Rev:$ $Date:$
*/
public class VersionChange {
private BundleCompatibility.VERSION_CHANGE_TYPE changeType;
private Version oldVersion;
Expand Down
2 changes: 1 addition & 1 deletion ...ning-checker/src/test/java/org/apache/aries/versioning/tests/BinaryCompatibilityTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ public void test_jdk_chap13_4_7_4() throws IOException {
}

/**
* Change the signature of the field from Colllection<AA> to Collection<String>
* Change the signature of the field from {@code Colllection<AA>} to {@code Collection<String>}
*/
@Test
public void test_jdk_chap13_4_7_5() {
Expand Down
2 changes: 1 addition & 1 deletion versioning/versioning-plugin/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<parent>
<groupId>org.apache.aries</groupId>
<artifactId>parent</artifactId>
<version>3.1.0</version>
<version>3.1.1-SNAPSHOT</version>
<relativePath>../../parent/pom.xml</relativePath>
</parent>

Expand Down