Cosmetic javadoc improvements (code blocks etc.)

dev-aspectj · Feb 11, 2024 · 55194df · 55194df
1 parent 7cb35d3
commit 55194df
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 21 deletions.
diff --git 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:
-     * <pre>
-     * &lt;configuration&gt;
-     *   &lt;Xset&gt;
-     *     &lt;overWeaving&gt;true&lt;/overWeaving&gt;
-     *     &lt;avoidFinal&gt;false&lt;/avoidFinal&gt;
-     *   &lt;/Xset&gt;
-     * &lt;/configuration&gt;
-     * </pre>
+     * <pre>{@code
+     * <configuration>
+     *   <Xset>
+     *     <overWeaving>true</overWeaving>
+     *     <avoidFinal>false</avoidFinal>
+     *   </Xset>
+     * </configuration>
+     * }</pre>
      *
      * @since 1.5
      */
@@ -415,7 +415,7 @@ public abstract class AbstractAjcCompiler extends AbstractAjcMojo {
      * <a href="https://maven.apache.org/guides/mini/guide-reproducible-builds.html">reproducible builds</a>.
      * <p>
      * A typical <i>builddef.lst</i> file might look like this:
-     * <pre><code>
+     * <pre>{@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
-     * </code></pre>
+     * }</pre>
      */
     @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
@@ -243,7 +243,7 @@ public static Set<String> 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 <i>dirsAndJars</i>
      * @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:
      *
-     * <pre>
-     *         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
-     * </pre>
+     * <pre>{@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
+     * }</pre>
      *
      * @param inExcludeString in-/exclude string
      * @param basedir the baseDirectory