This is an automated email from the ASF dual-hosted git repository.
alien11689 pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/aries.git
The following commit(s) were added to refs/heads/trunk by this push:
new 6e1d5ccb1 ARIES-2240: Configure javadoc for spi-fly (#880)
6e1d5ccb1 is described below
commit 6e1d5ccb155e1e3c49938880afc8434575a06aa7
Author: Dominik Przybysz <[email protected]>
AuthorDate: Fri Aug 7 06:34:45 2026 +0200
ARIES-2240: Configure javadoc for spi-fly (#880)
---
spi-fly/pom.xml | 18 ++++++++++++++++++
.../aries/spifly/ConsumerHeaderProcessor.java | 22 +++++++++++-----------
2 files changed, 29 insertions(+), 11 deletions(-)
diff --git a/spi-fly/pom.xml b/spi-fly/pom.xml
index 293761d49..ce1bd040b 100644
--- a/spi-fly/pom.xml
+++ b/spi-fly/pom.xml
@@ -65,6 +65,7 @@
<junit-platform.version>1.14.4</junit-platform.version>
<junit.version>4.13.2</junit.version>
<maven-compiler-plugin.version>3.15.0</maven-compiler-plugin.version>
+ <aries.javadoc.exclude.packages></aries.javadoc.exclude.packages>
<maven-dependency-plugin.version>3.11.0</maven-dependency-plugin.version>
<maven-enforcer-plugin.version>3.6.3</maven-enforcer-plugin.version>
<maven-surefire-plugin.version>3.5.6</maven-surefire-plugin.version>
@@ -189,6 +190,23 @@
</execution>
</executions>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <source>${java.source.version}</source>
+ <quiet>true</quiet>
+
<excludePackageNames>${aries.javadoc.exclude.packages}</excludePackageNames>
+ </configuration>
+ <executions>
+ <execution>
+ <id>attach-javadocs</id>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
</build>
diff --git
a/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/ConsumerHeaderProcessor.java
b/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/ConsumerHeaderProcessor.java
index 71408ee12..b3cb8a96b 100644
---
a/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/ConsumerHeaderProcessor.java
+++
b/spi-fly/spi-fly-core/src/main/java/org/apache/aries/spifly/ConsumerHeaderProcessor.java
@@ -49,29 +49,29 @@ public class ConsumerHeaderProcessor {
/**
* Parses headers of the following syntax:
* <ul>
- * <li><tt>org.acme.MyClass#myMethod</tt> - apply the weaving to all
overloads of <tt>myMethod()</tt>
- * in <tt>MyClass</tt>
- * <li><tt>org.acme.MyClass#myMethod(java.lang.String,
java.util.List)</tt> - apply the weaving only
- * to the <tt>myMethod(String, List)</tt> overload in <tt>MyClass</tt>
- * <li><tt>org.acme.MyClass#myMethod()</tt> - apply the weaving only to
the noarg overload of
- * <tt>myMethod()</tt>
- * <li><b>true</b> - equivalent to
<tt>java.util.ServiceLoader#load(java.lang.Class)</tt>
+ * <li><code>org.acme.MyClass#myMethod</code> - apply the weaving to all
overloads of <code>myMethod()</code>
+ * in <code>MyClass</code>
+ * <li><code>org.acme.MyClass#myMethod(java.lang.String,
java.util.List)</code> - apply the weaving only
+ * to the <code>myMethod(String, List)</code> overload in
<code>MyClass</code>
+ * <li><code>org.acme.MyClass#myMethod()</code> - apply the weaving only
to the noarg overload of
+ * <code>myMethod()</code>
+ * <li><b>true</b> - equivalent to
<code>java.util.ServiceLoader#load(java.lang.Class)</code>
* </ul>
* Additionally, it registers the consumer's constraints with the consumer
registry in the activator, if the
* consumer is only constrained to a certain set of bundles.<p>
*
* The following attributes are supported:
* <ul>
- * <li><tt>bundle</tt> - restrict wiring to the bundle with the specifies
Symbolic Name. The attribute value
+ * <li><code>bundle</code> - restrict wiring to the bundle with the
specifies Symbolic Name. The attribute value
* is a list of bundle identifiers separated by a '|' sign. The bundle
identifier starts with the Symbolic name
* and can optionally contain a version suffix. E.g.
bundle=impl2:version=1.2.3 or bundle=impl2|impl4.
- * <li><tt>bundleId</tt> - restrict wiring to the bundle with the
specified bundle ID. Typically used when
- * the service should be forcibly picked up from the system bundle
(<tt>bundleId=0</tt>). Multiple bundle IDs
+ * <li><code>bundleId</code> - restrict wiring to the bundle with the
specified bundle ID. Typically used when
+ * the service should be forcibly picked up from the system bundle
(<code>bundleId=0</code>). Multiple bundle IDs
* can be specified separated by a '|' sign.
* </ul>
*
* @param consumerHeaderName the name of the header (either
Require-Capability or SPI-Consumer)
- * @param consumerHeader the <tt>SPI-Consumer</tt> header.
+ * @param consumerHeader the <code>SPI-Consumer</code> header.
* @return an instance of the {@link WeavingData} class.
* @throws Exception when a header cannot be parsed.
*/
