aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kriegisch <Alexander@Kriegisch.name>2024-01-06 12:49:48 +0700
committerAlexander Kriegisch <Alexander@Kriegisch.name>2024-01-06 10:09:11 +0100
commitcbe376dab2172f70c0b3650297e416c8a89d04a8 (patch)
tree3c5ba9130753ac7d7ac78a9aa375914503da6dcd
parent41b8bc56dae8e1cb021c9e52d687951ea4cd765e (diff)
downloadaspectj-cbe376dab2172f70c0b3650297e416c8a89d04a8.tar.gz
aspectj-cbe376dab2172f70c0b3650297e416c8a89d04a8.zip
Add runtime and weaver API javadocs to installer again
Closes #271. Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
-rw-r--r--aspectjrt/pom.xml28
-rw-r--r--aspectjweaver/pom.xml28
-rw-r--r--docs/index.adoc12
3 files changed, 65 insertions, 3 deletions
diff --git a/aspectjrt/pom.xml b/aspectjrt/pom.xml
index 624f2a5df..2ef34a1f4 100644
--- a/aspectjrt/pom.xml
+++ b/aspectjrt/pom.xml
@@ -205,6 +205,34 @@
</executions>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-resources-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>copy-javadoc-to-dist</id>
+ <phase>package</phase>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+ <configuration>
+ <!--
+ Skip, if javadoc generation is also meant to be skipped, which is the default unless the 'release'
+ profile is active or the property is overridden manually to be false. See property definitions in parent
+ POM for default case and release profile.
+ -->
+ <skip>${maven.javadoc.skip}</skip>
+ <outputDirectory>${project.basedir}/../aj-build/dist/docs/doc/runtime-api</outputDirectory>
+ <resources>
+ <resource>
+ <directory>${project.build.directory}/apidocs</directory>
+ </resource>
+ </resources>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+
<!-- Caveat: Attaching the flattened POM needs packaging=jar, so do not use packaging=pom for this module -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
diff --git a/aspectjweaver/pom.xml b/aspectjweaver/pom.xml
index fb445fe14..34cefc74c 100644
--- a/aspectjweaver/pom.xml
+++ b/aspectjweaver/pom.xml
@@ -286,6 +286,34 @@
</executions>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-resources-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>copy-javadoc-to-dist</id>
+ <phase>package</phase>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+ <configuration>
+ <!--
+ Skip, if javadoc generation is also meant to be skipped, which is the default unless the 'release'
+ profile is active or the property is overridden manually to be false. See property definitions in parent
+ POM for default case and release profile.
+ -->
+ <skip>${maven.javadoc.skip}</skip>
+ <outputDirectory>${project.basedir}/../aj-build/dist/docs/doc/weaver-api</outputDirectory>
+ <resources>
+ <resource>
+ <directory>${project.build.directory}/apidocs</directory>
+ </resource>
+ </resources>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+
<!-- Caveat: Attaching the flattened POM needs packaging=jar, so do not use packaging=pom for this module -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
diff --git a/docs/index.adoc b/docs/index.adoc
index 21ffd5136..ba508e433 100644
--- a/docs/index.adoc
+++ b/docs/index.adoc
@@ -13,7 +13,8 @@ materials, see https://eclipse.org/aspectj. Not all of these materials have been
|xref:faq/faq.adoc#faq[FAQ], xref:quickref/quick5.pdf[Quick Reference (AspectJ 5)],
xref:quickref/quick.pdf[Quick Reference (1.2.1)], xref:adk15notebook/index.adoc[AspectJ 5 Developer's Notebook],
xref:progguide/index.adoc[programming], xref:devguide/index.adoc[development] and
-xref:pdguide/index.adoc[problem diagnosis] guides, link:runtime-api/index.html[API] and
+xref:pdguide/index.adoc[problem diagnosis] guides, link:runtime-api/index.html[runtime API],
+link:weaver-api/index.html[weaver API] and
link:https://github.com/eclipse-aspectj/aspectj/tree/master/docs/examples[example code]
|xref:#distributions[Distributions]
@@ -79,9 +80,14 @@ a|Problem Diagnosis Guide
|Guide to various debugging features available, such as messages and trace to help you both solve problems with you own
programs and report bugs to the AspectJ team
-|xref:runtime-api/index.html[AspectJ API]
+|xref:runtime-api/index.html[AspectJ Runtime API]
|API documentation for AspectJ runtime classes. `JoinPoint` shows the state automatically available at each join point.
-See also the xref:weaver-api/index.html[Weaver API].
+`ProceedingJoinPoint` explains how to `proceed(..)` to the intercepted join point from an around advice.
+
+|xref:weaver-api/index.html[AspectJ Weaver API]
+|API documentation for AspectJ weaver classes. This is a superset of the runtime API plus all the additional classes
+used for byte code weaving, both during compilation from source code and binary weaving during post-compile and
+load-time weaving.
|xref:faq/faq.adoc#faq[FAQ]
|Frequently asked questions about the AspectJ language, tools, and project