diff options
author | Alexander Kriegisch <Alexander@Kriegisch.name> | 2024-01-31 13:40:34 +0700 |
---|---|---|
committer | Alexander Kriegisch <Alexander@Kriegisch.name> | 2024-02-01 08:58:27 +0700 |
commit | 06557e86b01bf0c2a58a58e6d322f8c576b0acba (patch) | |
tree | c574b06f59d55cf3ba7f13528916ef9382fc9ba6 /docs/modules/devguide | |
parent | c6de70659e3b52e6f6df5e309902a2fa5c8981ce (diff) | |
download | aspectj-06557e86b01bf0c2a58a58e6d322f8c576b0acba.tar.gz aspectj-06557e86b01bf0c2a58a58e6d322f8c576b0acba.zip |
Fix several structural asciidoc warnings
In changes.adoc, also make headlines and TOC more readable.
To avoid some "image not found" warnings, move images directory in ROOT
module to the canonical level. This also required a small change in
IDE.md.
Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
Diffstat (limited to 'docs/modules/devguide')
-rw-r--r-- | docs/modules/devguide/pages/ajc.adoc | 4 | ||||
-rw-r--r-- | docs/modules/devguide/pages/antsupport.adoc | 20 | ||||
-rw-r--r-- | docs/modules/devguide/pages/compatibility.adoc | 2 | ||||
-rw-r--r-- | docs/modules/devguide/pages/devguide.adoc | 2 | ||||
-rw-r--r-- | docs/modules/devguide/pages/index.adoc | 2 | ||||
-rw-r--r-- | docs/modules/devguide/pages/tools-intro.adoc | 4 |
6 files changed, 17 insertions, 17 deletions
diff --git a/docs/modules/devguide/pages/ajc.adoc b/docs/modules/devguide/pages/ajc.adoc index 078ef5ff4..09cf44a3c 100644 --- a/docs/modules/devguide/pages/ajc.adoc +++ b/docs/modules/devguide/pages/ajc.adoc @@ -28,7 +28,7 @@ include the source not only for the aspects or pointcuts but also for any affected types. Specifying all sources is necessary because, unlike javac, ajc does not search the sourcepath for classes. (For a discussion of what affected types might be required, see -xref:../progguide/implementation.html[The AspectJ Programming Guide, +xref:progguide:implementation.adoc[The AspectJ Programming Guide, Implementation Appendix].) To specify sources, you can list source files as arguments or use the @@ -91,7 +91,7 @@ destination directory on the inpath and rebuild.) Generate .ajesym symbol files for emacs support (deprecated). `-Xlint`:: Same as -Xlint:warning (enabled by default) -`-Xlint:{level}`:: +`-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 diff --git a/docs/modules/devguide/pages/antsupport.adoc b/docs/modules/devguide/pages/antsupport.adoc index ba74d32dd..9a13b56ab 100644 --- a/docs/modules/devguide/pages/antsupport.adoc +++ b/docs/modules/devguide/pages/antsupport.adoc @@ -34,7 +34,7 @@ v 2.0 at https://eclipse.org/aspectj. In Ant 1.5, third-party tasks can be declared using a taskdef entry in the build script, to identify the name and classes. When declaring a task, include the `aspectjtools.jar` either in the taskdef classpath or -in `${ANT_HOME}/lib` where it will be added to the system class path by +in `$\{ANT_HOME}/lib` where it will be added to the system class path by the ant script. You may specify the task script names directly, or use the "resource" attribute to specify the default names: @@ -49,7 +49,7 @@ uses "iajc" for the AspectJ post-1.1 task. In Ant 1.6, third-party tasks are declared in their own namespace using `antlib.xml`. For example, the following script would build and run the spacewar example, if you put the script in the examples directory and -`aspectjtools.jar` in the `${ANT_HOME}/lib` directory. +`aspectjtools.jar` in the `$\{ANT_HOME}/lib` directory. [source, xml] .... @@ -370,7 +370,7 @@ specified using the refid attribute: </iajc> .... -The task also supports an attribute `{name}ref` for each such parameter. +The task also supports an attribute `\{name}ref` for each such parameter. E.g., for `aspectpath`: [source, xml] @@ -510,7 +510,7 @@ that can be handled by iajc/ajc. === Sample of compiler adapter To build using the adapter, put the `aspectjtools.jar` on the system/ant -classpath (e.g., in `${ANT_HOME}/lib`) and define the `build.compiler` +classpath (e.g., in `$\{ANT_HOME}/lib`) and define the `build.compiler` property as the fully-qualified name of the class, `org.aspectj.tools.ant.taskdefs.Ajc11CompilerAdapter`. @@ -580,10 +580,10 @@ in javac). as the message holder. * `-Xcopyinjars`: copy resources from any input jars to output (default behavior since 1.1.1) -* `-Xsourcerootcopyfilter {filter}`: copy resources from source +* `-Xsourcerootcopyfilter \{filter}`: copy resources from source directories to output (minus files specified in filter) -* `-Xtagfile {file}`: use file to control incremental compilation -* `-Xsrcdir {dir}`: add to list of ajc source roots (all source files +* `-Xtagfile \{file}`: use file to control incremental compilation +* `-Xsrcdir \{dir}`: add to list of ajc source roots (all source files will be included). Special considerations when using Javac and compilerarg: @@ -735,7 +735,7 @@ argfile). ==== argfiles - argument list files -An argument file is a file (usually `{file}.lst`) containing a list of +An argument file is a file (usually `\{file}.lst`) containing a list of source file paths (absolute or relative to the argfile). You can use it to specify all source files to be compiled, which ajc requires to avoid searching every possible source file in the source path when building @@ -818,8 +818,8 @@ This next example /> .... -compiles .java files under the `${src}` directory in the spacewar and -coordination packages, and stores the .class files in the `${build}` +compiles .java files under the `$\{src}` directory in the spacewar and +coordination packages, and stores the .class files in the `$\{build}` directory. All source files under spacewar/ and coordination/ are used, except Debug.java. diff --git a/docs/modules/devguide/pages/compatibility.adoc b/docs/modules/devguide/pages/compatibility.adoc index ea96ebf3c..f96811f30 100644 --- a/docs/modules/devguide/pages/compatibility.adoc +++ b/docs/modules/devguide/pages/compatibility.adoc @@ -87,7 +87,7 @@ were necessary when moving to binary weaving in the 1.1 release, but at this time we don't anticipate more in the future. You might also find that the program behaves differently if you relied on behavior specific to that compiler/weaver, but which is not specified in the -xref:../progguide/semantics.html[Semantics appendix to the Programming +xref:progguide:semantics.adoc[Semantics appendix to the Programming Guide]. [[upgrading]] diff --git a/docs/modules/devguide/pages/devguide.adoc b/docs/modules/devguide/pages/devguide.adoc index 2dda421e8..2ca13a01c 100644 --- a/docs/modules/devguide/pages/devguide.adoc +++ b/docs/modules/devguide/pages/devguide.adoc @@ -8,7 +8,7 @@ _Copyright (c) 1998-2001 Xerox Corporation, 2002 Palo Alto Research Center, Inco All rights reserved._ This guide describes how to build and deploy AspectJ programs using the AspectJ tools and facilities. See also the -xref:../progguide/progguide.adoc[AspectJ Programming Guide], the documentation available with the AspectJ support +xref:progguide:progguide.adoc[AspectJ Programming Guide], the documentation available with the AspectJ support available for various integrated development environments (e.g. https://www.eclipse.org/ajdt/[Eclipse AJDT]), and the most-recent documentation available from the https://eclipse.org/aspectj[AspectJ project page]. diff --git a/docs/modules/devguide/pages/index.adoc b/docs/modules/devguide/pages/index.adoc index 4d74c3261..152cb1762 100644 --- a/docs/modules/devguide/pages/index.adoc +++ b/docs/modules/devguide/pages/index.adoc @@ -8,7 +8,7 @@ _Copyright (c) 1998-2001 Xerox Corporation, 2002 Palo Alto Research Center, Inco All rights reserved._ This guide describes how to build and deploy AspectJ programs using the AspectJ tools and facilities. See also the -xref:../progguide/progguide.adoc[AspectJ Programming Guide], the documentation available with the AspectJ support +xref:progguide:progguide.adoc[AspectJ Programming Guide], the documentation available with the AspectJ support available for various integrated development environments (e.g. https://www.eclipse.org/ajdt/[Eclipse AJDT]), and the most-recent documentation available from the https://eclipse.org/aspectj[AspectJ project page]. diff --git a/docs/modules/devguide/pages/tools-intro.adoc b/docs/modules/devguide/pages/tools-intro.adoc index c9bd34ea5..b9946c94f 100644 --- a/docs/modules/devguide/pages/tools-intro.adoc +++ b/docs/modules/devguide/pages/tools-intro.adoc @@ -4,7 +4,7 @@ [[eclipse-aspectj]] == The Eclipse AspectJ implementation -The xref:../progguide/index.html[AspectJ Programming Guide] describes +The xref:progguide:index.adoc[AspectJ Programming Guide] describes the AspectJ language. This guide describes the AspectJ tools produced by the AspectJ team on https://eclipse.org/aspectj. The AspectJ tools include - ajc, the compiler/weaver; ajdoc, a documentation tool; @@ -24,7 +24,7 @@ files that run in a Java VM. There are other ways to implement the language (e.g., compiler preprocessor, VM support); the AspectJ team has always tried to distinguish the language and the implementation so other groups could build alternative implementations of AspectJ. To that end, -xref:../progguide/implementation.html[The AspectJ Programming Guide, +xref:progguide:implementation.adoc[The AspectJ Programming Guide, Implementation Notes] describes how the Java bytecode form affects language semantics. VM- or source-based implementations may be free of these limits or impose limits of their own, but most should be fairly |