Skip to content

Fixes minor bug in documentation #147

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixes minor bug in documentation #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,10 @@
<!-- Suppress timestamp meta tag -->
<docdate/>
<docdatetime/>

<!-- project specific -->
<project-version>${project.version}</project-version>
<project-groupId>${project.groupId}</project-groupId>
</attributes>
<requires>
<require>asciidoctor-diagram</require>
Expand Down
8 changes: 4 additions & 4 deletions src/site/asciidoc/examples/differentTestAndCompile.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

To have different weaving configurations for the main and test classes, you can configure the plugin as shown below.

[source,xml]
[source,xml,subs="attributes,verbatim"]
----
<project>
<!-- ... -->
Expand All @@ -14,17 +14,17 @@ To have different weaving configurations for the main and test classes, you can
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>${aspectjVersion}</version>
<version>{aspectjVersion}</version>
</dependency>
<!-- ... -->
</dependencies>
<!-- ... -->
<build>
<plugins>
<plugin>
<groupId>${project.groupId}</groupId>
<groupId>{project-groupId}</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${project.version}</version>
<version>{project-version}</version>
<executions>
<execution>
<id>compile</id>
Expand Down
16 changes: 8 additions & 8 deletions src/site/asciidoc/examples/includeExclude.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ implementation, an advanced implementation covering most needs regarding source
If you do not wish to use any source directory at all, e.g. in a plugin execution only doing binary weaving, you can
just add an empty `sources` tag, i.e. `<sources/>` (Maven 3 style) or `<sources><source/></sources>` (Maven 2 style).

[source,xml]
[source,xml,subs="attributes,verbatim"]
----
<project>
<!-- ... -->
Expand All @@ -22,17 +22,17 @@ just add an empty `sources` tag, i.e. `<sources/>` (Maven 3 style) or `<sources>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>${aspectjVersion}</version>
<version>{aspectjVersion}</version>
</dependency>
<!-- ... -->
</dependencies>
<!-- ... -->
<build>
<plugins>
<plugin>
<groupId>${project.groupId}</groupId>
<groupId>{project-groupId}</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${project.version}</version>
<version>{project-version}</version>
<configuration>
<sources>
<source>
Expand Down Expand Up @@ -67,7 +67,7 @@ just add an empty `sources` tag, i.e. `<sources/>` (Maven 3 style) or `<sources>
AspectJ Maven Plugin will by default add all `.java` and `.aj` files in the project source directories. Below, you find
an example of how to add include/exclude filtering on top of that.

[source,xml]
[source,xml,subs="attributes,verbatim"]
----
<project>
<!-- ... -->
Expand All @@ -76,17 +76,17 @@ an example of how to add include/exclude filtering on top of that.
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>${aspectjVersion}</version>
<version>{aspectjVersion}</version>
</dependency>
<!-- ... -->
</dependencies>
<!-- ... -->
<build>
<plugins>
<plugin>
<groupId>${project.groupId}</groupId>
<groupId>{project-groupId}</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${project.version}</version>
<version>{project-version}</version>
<configuration>
<includes>
<include>**/TransationAspect.java</include>
Expand Down
8 changes: 4 additions & 4 deletions src/site/asciidoc/examples/libraryJars.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ weaving in the plugin configuration as shown below.

**Note:** The artifacts you reference must exist as regular dependencies in your project.

[source,xml]
[source,xml,subs="attributes,verbatim"]
----
<project>
<!-- ... -->
Expand All @@ -17,7 +17,7 @@ weaving in the plugin configuration as shown below.
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>${aspectjVersion}</version>
<version>{aspectjVersion}</version>
</dependency>
<dependency>
<groupId>org.agroup</groupId>
Expand All @@ -35,9 +35,9 @@ weaving in the plugin configuration as shown below.
<build>
<plugins>
<plugin>
<groupId>${project.groupId}</groupId>
<groupId>{project-groupId}</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${project.version}</version>
<version>{project-version}</version>
<configuration>
<aspectLibraries>
<aspectLibrary>
Expand Down
8 changes: 4 additions & 4 deletions src/site/asciidoc/examples/usingReport.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ classes for javadoc generation on JDK 9+, you need to make sure that your `JAVA_
correct JDK before using this feature. You can just try your default setup, but if classes or libraries are not found,
you probably need to adjust your configuration correspondingly.

[source,xml]
[source,xml,subs="attributes,verbatim"]
----
<project>
<!-- ... -->
Expand All @@ -19,7 +19,7 @@ you probably need to adjust your configuration correspondingly.
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>${aspectjVersion}</version>
<version>{aspectjVersion}</version>
<scope>compile</scope>
</dependency>
<!-- ... -->
Expand All @@ -28,9 +28,9 @@ you probably need to adjust your configuration correspondingly.
<reporting>
<plugins>
<plugin>
<groupId>${project.groupId}</groupId>
<groupId>{project-groupId}</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${project.version}</version>
<version>{project-version}</version>
<configuration>
<verbose>true</verbose>
<privateScope>true</privateScope>
Expand Down
8 changes: 4 additions & 4 deletions src/site/asciidoc/examples/usingTogetherWithAJDT.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ To use this plugin together with AJDT (AspectJ Development Tools for Eclipse IDE
`ajdtBuildDefFile` property to point to the `build.ajproperties` file generated by AJDT. The use of this property
overrides the configured project source folders. Any include or exclude elements in the POM are also disregarded.

[source,xml]
[source,xml,subs="attributes,verbatim"]
----
<project>
<!-- ... -->
Expand All @@ -16,17 +16,17 @@ overrides the configured project source folders. Any include or exclude elements
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>${aspectjVersion}</version>
<version>{aspectjVersion}</version>
</dependency>
<!-- ... -->
</dependencies>
<!-- ... -->
<build>
<plugins>
<plugin>
<groupId>${project.groupId}</groupId>
<groupId>{project-groupId}</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${project.version}</version>
<version>{project-version}</version>
<configuration>
<ajdtBuildDefFile>build.ajproperties</ajdtBuildDefFile>
</configuration>
Expand Down
4 changes: 2 additions & 2 deletions src/site/asciidoc/examples/weaveDirectories.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ specify the folder(s) with the compiled classes via `weaveDirectories` and execu
default phases `compile` and `test-compile`,
* or you select later phases for AspectJ Maven Plugin, i.e. `process-classes` and `process-test-classes` or later.

[source,xml]
[source,xml,subs="attributes,verbatim"]
----
<project>
<!-- ... -->
Expand All @@ -35,7 +35,7 @@ specify the folder(s) with the compiled classes via `weaveDirectories` and execu
</executions>
</plugin>
<plugin>
<groupId>${project.groupId}</groupId>
<groupId>{project-groupId}</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<configuration>
<weaveDirectories>
Expand Down
8 changes: 4 additions & 4 deletions src/site/asciidoc/examples/weaveJars.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ you need do configure all the JAR files you want to weave in the plugin configur

**Note:** The artifacts you reference must exist as regular dependencies in the project.

[source,xml]
[source,xml,subs="attributes,verbatim"]
----
<project>
<!-- ... -->
Expand All @@ -17,7 +17,7 @@ you need do configure all the JAR files you want to weave in the plugin configur
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>${aspectjVersion}</version>
<version>{aspectjVersion}</version>
</dependency>

<dependency>
Expand All @@ -37,9 +37,9 @@ you need do configure all the JAR files you want to weave in the plugin configur
<build>
<plugins>
<plugin>
<groupId>${project.groupId}</groupId>
<groupId>{project-groupId}</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${project.version}</version>
<version>{project-version}</version>
<configuration>
<weaveDependencies>
<weaveDependency>
Expand Down
12 changes: 6 additions & 6 deletions src/site/asciidoc/multimodule/multimodule_strategy.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ Now that our tiny validation API is complete, it is time to implement its corres
that the `validation-aspect` module assigns its POM parent to `rootParentPOM`, since we want to use the AspectJ
dependencies managed in the parent. The POM bits of the `validation-aspect` project are shown below:

[source,xml]
[source,xml,subs="attributes,verbatim"]
----
<!-- +========================================= -->
<!-- | Define the Parent POM -->
Expand Down Expand Up @@ -210,9 +210,9 @@ dependencies managed in the parent. The POM bits of the `validation-aspect` proj
<build>
<plugins>
<plugin>
<groupId>${project.groupId}</groupId>
<groupId>{project-groupId}</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${project.version}</version>
<version>{project-version}</version>
<configuration>
<complianceLevel>8</complianceLevel>
</configuration>
Expand Down Expand Up @@ -344,7 +344,7 @@ The last piece of the AspectJ plugin puzzle is the inclusion of our validation a
which is performed within the `aspectParentPOM` module. The `aspectParentPOM` must therefore include a dependency on the
`validation-aspect` project, and use the `rootParentPOM` as a parent.

[source,xml]
[source,xml,subs="attributes,verbatim"]
----
<!-- +========================================= -->
<!-- | Define the Parent POM -->
Expand Down Expand Up @@ -386,9 +386,9 @@ which is performed within the `aspectParentPOM` module. The `aspectParentPOM` mu
<build>
<plugins>
<plugin>
<groupId>${project.groupId}</groupId>
<groupId>{project-groupId}</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${project.version}</version>
<version>{project-version}</version>
<configuration>
<complianceLevel>8</complianceLevel>
<aspectDirectory>src/main/aspect</aspectDirectory>
Expand Down
14 changes: 7 additions & 7 deletions src/site/asciidoc/usage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ modules contain aspects and other modules within the Maven reactor contain code

Below follows a standard single-project usage example.

[source,xml]
[source,xml,subs="attributes,verbatim"]
----
<project>
<!-- ... -->
Expand All @@ -20,17 +20,17 @@ Below follows a standard single-project usage example.
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>${aspectjVersion}</version>
<version>{aspectjVersion}</version>
</dependency>
<!-- ... -->
</dependencies>
<!-- ... -->
<build>
<plugins>
<plugin>
<groupId>${project.groupId}</groupId>
<groupId>{project-groupId}</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${project.version}</version>
<version>{project-version}</version>
<executions>
<execution>
<goals>
Expand Down Expand Up @@ -58,7 +58,7 @@ This plugin's release frequency is lower than AspectJ's. Therefore, if for examp
you need to adjust the `aspectjtools` compiler dependency within the plugin and ideally also the `aspectjrt` runtime
used by the compiled module in sync with it.

[source,xml]
[source,xml,subs="attributes,verbatim"]
----
<project>
<!-- ... -->
Expand All @@ -81,9 +81,9 @@ used by the compiled module in sync with it.
<build>
<plugins>
<plugin>
<groupId>${project.groupId}</groupId>
<groupId>{project-groupId}</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${project.version}</version>
<version>{project-version}</version>
<dependencies>
<dependency>
<groupId>org.aspectj</groupId>
Expand Down