Skip to content

Commit 55194df

Browse files
committed
Cosmetic javadoc improvements (code blocks etc.)
1 parent 7cb35d3 commit 55194df

File tree

2 files changed

+20
-21
lines changed

2 files changed

+20
-21
lines changed

src/main/java/org/codehaus/mojo/aspectj/AbstractAjcCompiler.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -142,14 +142,14 @@ public abstract class AbstractAjcCompiler extends AbstractAjcMojo {
142142

143143
/**
144144
* Allows the caller to provide additional arguments in a Map format. For example:
145-
* <pre>
146-
* &lt;configuration&gt;
147-
* &lt;Xset&gt;
148-
* &lt;overWeaving&gt;true&lt;/overWeaving&gt;
149-
* &lt;avoidFinal&gt;false&lt;/avoidFinal&gt;
150-
* &lt;/Xset&gt;
151-
* &lt;/configuration&gt;
152-
* </pre>
145+
* <pre>{@code
146+
* <configuration>
147+
* <Xset>
148+
* <overWeaving>true</overWeaving>
149+
* <avoidFinal>false</avoidFinal>
150+
* </Xset>
151+
* </configuration>
152+
* }</pre>
153153
*
154154
* @since 1.5
155155
*/
@@ -415,7 +415,7 @@ public abstract class AbstractAjcCompiler extends AbstractAjcMojo {
415415
* <a href="https://maven.apache.org/guides/mini/guide-reproducible-builds.html">reproducible builds</a>.
416416
* <p>
417417
* A typical <i>builddef.lst</i> file might look like this:
418-
* <pre><code>
418+
* <pre>{@code
419419
* -1.8
420420
* -encoding
421421
* UTF-8
@@ -424,7 +424,7 @@ public abstract class AbstractAjcCompiler extends AbstractAjcMojo {
424424
* -d
425425
* /my/project/target/classes
426426
* /my/project/src/main/java/org/acme/ValidationAspect.java
427-
* </code></pre>
427+
* }</pre>
428428
*/
429429
@Parameter( defaultValue = "builddef.lst" )
430430
protected String argumentFileName = "builddef.lst";

src/main/java/org/codehaus/mojo/aspectj/AjcHelper.java

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ public static Set<String> getWeaveSourceFiles( String[] weaveDirs )
243243
* Based on a set of JARs and directories, returns a set of all JARs and class files
244244
*
245245
* @param dirsAndJars JARs and base directories to be scanned
246-
* @param outDir
246+
* @param outDir build output directory
247247
* @return a set of all JARs and class files found in the <i>dirsAndJars</i>
248248
* @throws MojoExecutionException if any IOExceptions occur
249249
*/
@@ -355,17 +355,16 @@ protected static String getAsCsv( String[] strings )
355355

356356
/**
357357
* Helper method to find all .java or .aj files specified by the
358-
* inExcludeString. The includeString is a comma separated list over files, or
359-
* directories relative to the specified basedir. Examples of correct
360-
* listings
358+
* inExcludeString. The includeString is a comma-separated list over files, or
359+
* directories relative to the specified basedir. Examples of correct listings:
361360
*
362-
* <pre>
363-
* src/main/java/
364-
* src/main/java
365-
* src/main/java/com/project/AClass.java
366-
* src/main/java/com/project/AnAspect.aj
367-
* src/main/java/com/project/AnAspect.java
368-
* </pre>
361+
* <pre>{@code
362+
* src/main/java/
363+
* src/main/java
364+
* src/main/java/com/project/AClass.java
365+
* src/main/java/com/project/AnAspect.aj
366+
* src/main/java/com/project/AnAspect.java
367+
* }</pre>
369368
*
370369
* @param inExcludeString in-/exclude string
371370
* @param basedir the baseDirectory

0 commit comments

Comments
 (0)