From 55194df70e16c06fc6db126136a684093869b734 Mon Sep 17 00:00:00 2001 From: Alexander Kriegisch Date: Sun, 11 Feb 2024 11:29:04 +0700 Subject: [PATCH] Cosmetic javadoc improvements (code blocks etc.) --- .../mojo/aspectj/AbstractAjcCompiler.java | 20 +++++++++--------- .../org/codehaus/mojo/aspectj/AjcHelper.java | 21 +++++++++---------- 2 files changed, 20 insertions(+), 21 deletions(-) diff --git a/src/main/java/org/codehaus/mojo/aspectj/AbstractAjcCompiler.java b/src/main/java/org/codehaus/mojo/aspectj/AbstractAjcCompiler.java index 5dc1d03..d95fb05 100644 --- a/src/main/java/org/codehaus/mojo/aspectj/AbstractAjcCompiler.java +++ b/src/main/java/org/codehaus/mojo/aspectj/AbstractAjcCompiler.java @@ -142,14 +142,14 @@ public abstract class AbstractAjcCompiler extends AbstractAjcMojo { /** * Allows the caller to provide additional arguments in a Map format. For example: - *
-     * <configuration>
-     *   <Xset>
-     *     <overWeaving>true</overWeaving>
-     *     <avoidFinal>false</avoidFinal>
-     *   </Xset>
-     * </configuration>
-     * 
+ *
{@code
+     * 
+     *   
+     *     true
+     *     false
+     *   
+     * 
+     * }
* * @since 1.5 */ @@ -415,7 +415,7 @@ public abstract class AbstractAjcCompiler extends AbstractAjcMojo { * reproducible builds. *

* A typical builddef.lst file might look like this: - *


+     * 
{@code
      * -1.8
      * -encoding
      * UTF-8
@@ -424,7 +424,7 @@ public abstract class AbstractAjcCompiler extends AbstractAjcMojo {
      * -d
      * /my/project/target/classes
      * /my/project/src/main/java/org/acme/ValidationAspect.java
-     * 
+ * }
*/ @Parameter( defaultValue = "builddef.lst" ) protected String argumentFileName = "builddef.lst"; diff --git a/src/main/java/org/codehaus/mojo/aspectj/AjcHelper.java b/src/main/java/org/codehaus/mojo/aspectj/AjcHelper.java index c1509b6..df395d3 100644 --- a/src/main/java/org/codehaus/mojo/aspectj/AjcHelper.java +++ b/src/main/java/org/codehaus/mojo/aspectj/AjcHelper.java @@ -243,7 +243,7 @@ public static Set getWeaveSourceFiles( String[] weaveDirs ) * Based on a set of JARs and directories, returns a set of all JARs and class files * * @param dirsAndJars JARs and base directories to be scanned - * @param outDir + * @param outDir build output directory * @return a set of all JARs and class files found in the dirsAndJars * @throws MojoExecutionException if any IOExceptions occur */ @@ -355,17 +355,16 @@ protected static String getAsCsv( String[] strings ) /** * Helper method to find all .java or .aj files specified by the - * inExcludeString. The includeString is a comma separated list over files, or - * directories relative to the specified basedir. Examples of correct - * listings + * inExcludeString. The includeString is a comma-separated list over files, or + * directories relative to the specified basedir. Examples of correct listings: * - *
-     *         src/main/java/
-     *         src/main/java
-     *         src/main/java/com/project/AClass.java
-     *         src/main/java/com/project/AnAspect.aj
-     *         src/main/java/com/project/AnAspect.java
-     * 
+ *
{@code
+     * src/main/java/
+     * src/main/java
+     * src/main/java/com/project/AClass.java
+     * src/main/java/com/project/AnAspect.aj
+     * src/main/java/com/project/AnAspect.java
+     * }
* * @param inExcludeString in-/exclude string * @param basedir the baseDirectory