From: Alexander Kriegisch <Alexander@Kriegisch.name>
Date: Thu, 22 Feb 2024 03:24:56 +0000 (+0700)
Subject: ajc.adoc: Cosmetic improvements
X-Git-Tag: V1_9_21_2~15
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=55708c8875719efd0ac2817512dc09b51184e792;p=aspectj.git

ajc.adoc: Cosmetic improvements

Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
---

diff --git a/docs/devguide/ajc.adoc b/docs/devguide/ajc.adoc
index 1a562a791..f1ac8b860 100644
--- a/docs/devguide/ajc.adoc
+++ b/docs/devguide/ajc.adoc
@@ -41,7 +41,7 @@ destination directory on the inpath and rebuild.)
 === Options
 
 `-injars <JarList>`::
-  deprecated: since 1.2, use -inpath, which also takes directories.
+  deprecated: since 1.2, use `-inpath`, which also takes directories.
 `-inpath <Path>`::
   Accept as source bytecode any .class files in the .jar files or
   directories on Path. The output will include these classes, possibly
@@ -54,7 +54,7 @@ destination directory on the inpath and rebuild.)
   the compiler. When running the output classes, the run classpath
   should contain all aspectpath entries. Path, like classpath, is a
   single argument containing a list of paths to jar files, delimited by
-  the platform- specific classpath delimiter.
+  the platform-specific classpath delimiter.
 `-argfile <File>`::
   The file contains a line-delimited list of arguments. Each line in the
   file should contain one option, filename, or argument string (e.g., a
@@ -64,9 +64,9 @@ destination directory on the inpath and rebuild.)
   working directory). Comments, as in Java, start with `//` and extend
   to the end of the line. Options specified in argument files may
   override rather than extending existing option values, so avoid
-  specifying options like <-classpath> in argument files unlike the
-  argument file is the only build specification. The form <@file> is the
-  same as specifying <-argfile file>.
+  specifying options like `-classpath` in argument files unlike the
+  argument file is the only build specification. The form `@file` is the
+  same as specifying `-argfile file`.
 `-outjar <output.jar>`::
   Put output classes in zip file output.jar.
 `-outxml`::
@@ -78,7 +78,7 @@ destination directory on the inpath and rebuild.)
   compiler will wait to recompile until it reads a newline from the
   standard input, and will quit when it reads a 'q'. It will only
   recompile necessary components, so a recompile should be much faster
-  than doing a second compile. This requires -sourceroots.
+  than doing a second compile. This requires `-sourceroots`.
 `-sourceroots <DirPaths>`::
   Find and build all .java or .aj source files under any directory
   listed in DirPaths. DirPaths, like classpath, is a single argument
@@ -132,15 +132,15 @@ load-time weaving configuration by _aop.xml_. Current limitations include:
   Same as -Xlint:warning (enabled by default)
 `-Xlint:\{level}`::
   Set default level for messages about potential programming mistakes in
-  crosscutting code. \{level} may be ignore, warning, or error. This
-  overrides entries in org/aspectj/weaver/XlintDefault.properties from
+  crosscutting code. `\{level}` may be `ignore`, `warning`, or `error`. This
+  overrides entries in _org/aspectj/weaver/XlintDefault.properties_ from
   aspectjtools.jar, but does not override levels set using the
-  -Xlintfile option.
+  `-Xlintfile` option.
 `-Xlintfile <PropertyFile>`::
   Specify properties file to set levels for specific crosscutting
   messages. PropertyFile is a path to a Java .properties file that takes
   the same property names and values as
-  org/aspectj/weaver/XlintDefault.properties from aspectjtools.jar,
+  _org/aspectj/weaver/XlintDefault.properties_ from aspectjtools.jar,
   which it also overrides.
 `-help`::
   Emit information on compiler options and usage
@@ -174,11 +174,11 @@ load-time weaving configuration by _aop.xml_. Current limitations include:
   E.g., `-11` implies `-source 11` and `-target 11`.
 
 `-nowarn`::
-  Emit no warnings (equivalent to '-warn:none') This does not suppress
+  Emit no warnings (equivalent to `-warn:none`) This does not suppress
   messages generated by `declare warning` or `Xlint`.
 `-warn: <items>`::
   Emit warnings for any instances of the comma-delimited list of
-  questionable code (eg '-warn:unusedLocals,deprecation'):
+  questionable code (e.g. `-warn:unusedLocals,deprecation`):
 +
 [source, text]
 ....
@@ -195,7 +195,7 @@ none                   suppress all compiler warnings
 `-warn:none` does not suppress messages generated by `declare warning`
   or `Xlint`.
 `-deprecation`::
-  Same as -warn:deprecation
+  Same as `-warn:deprecation`
 `-noImportError`::
   Emit no errors for unresolved imports
 `-proceedOnError`::
@@ -217,7 +217,7 @@ none                   suppress all compiler warnings
   Compute reference information.
 `-encoding <format>`::
   Specify default source encoding format. Specify custom encoding on a
-  per file basis by suffixing each input source file/folder name with
+  per-file basis by suffixing each input source file/folder name with
   '[encoding]'.
 `-verbose`::
   Emit messages about accessed/processed compilation units
@@ -230,7 +230,7 @@ none                   suppress all compiler warnings
 `-time`::
   Display speed information.
 `-noExit`::
-  Do not call System.exit(n) at end of compilation (n=0 if no error)
+  Do not call `System.exit(n)` at end of compilation (n=0 if no error)
 `-repeat <N>`::
   Repeat compilation process N times (typically to do performance
   analysis).