aboutsummaryrefslogtreecommitdiffstats
path: root/docs/modules/pdguide
diff options
context:
space:
mode:
Diffstat (limited to 'docs/modules/pdguide')
-rw-r--r--docs/modules/pdguide/pages/ajcore.adoc8
-rw-r--r--docs/modules/pdguide/pages/ltwdump.adoc8
-rw-r--r--docs/modules/pdguide/pages/messages.adoc18
-rw-r--r--docs/modules/pdguide/pages/pointcuts.adoc20
-rw-r--r--docs/modules/pdguide/pages/trace.adoc8
5 files changed, 31 insertions, 31 deletions
diff --git a/docs/modules/pdguide/pages/ajcore.adoc b/docs/modules/pdguide/pages/ajcore.adoc
index 5928d372d..39b727286 100644
--- a/docs/modules/pdguide/pages/ajcore.adoc
+++ b/docs/modules/pdguide/pages/ajcore.adoc
@@ -1,8 +1,8 @@
[[ajcore]]
-== AspectJ Core Files
+= AspectJ Core Files
[[ajcore-introduction]]
-=== Introduction
+== Introduction
When the compiler terminates abnormally, either because a particular
kind of message was issued or an exception was thrown, an AspectJ core
@@ -15,7 +15,7 @@ version. When submitting a bug, include this file whenever it is
available.
[[configuration]]
-==== Configuring dump files
+=== Configuring dump files
By default AspectJ will only create an `ajcore` file when an unexpected
exception is thrown by the weaver or an `abort` message is issued.
@@ -37,7 +37,7 @@ files.
|===
[[ajcore-examples]]
-==== AJCore File Examples
+=== AJCore File Examples
Below is an extract from an `ajcore` file. You will see details of the
dump configuration as well as the exception (with stack trace) that is
diff --git a/docs/modules/pdguide/pages/ltwdump.adoc b/docs/modules/pdguide/pages/ltwdump.adoc
index 8442a36a3..43d71805f 100644
--- a/docs/modules/pdguide/pages/ltwdump.adoc
+++ b/docs/modules/pdguide/pages/ltwdump.adoc
@@ -1,8 +1,8 @@
[[ltwdump]]
-== Dumping classes during load-time weaving
+= Dumping classes during load-time weaving
[[ltwdump-introduction]]
-=== Introduction
+== Introduction
Very rarely problems may be encountered with classes that have been
load-time woven. Symptoms will include incorrect program function or a
@@ -16,7 +16,7 @@ proxy or has already been instrumented by another agent) you can
configure the weaver to dump the input classes as well.
[[ltw-examples]]
-==== Configuring bytecode dumping in load-time weaving
+=== Configuring bytecode dumping in load-time weaving
For details of how to configure byte-code dumping, see the AspectJ
Development Environment Guide section on
@@ -24,7 +24,7 @@ xref:../devguide/ltw.html#configuring-load-time-weaving-with-aopxml-files[Config
Load-time Weaving]. Following is a simple example.
[[ltwdump-examples]]
-==== LTW Dump Examples
+=== LTW Dump Examples
The following `META-INF/aop.xml` will weave classes in the `com.foo`
package (and subpackages) but not CGLIB generated classes in the
diff --git a/docs/modules/pdguide/pages/messages.adoc b/docs/modules/pdguide/pages/messages.adoc
index b9b1779d5..c32d07f07 100644
--- a/docs/modules/pdguide/pages/messages.adoc
+++ b/docs/modules/pdguide/pages/messages.adoc
@@ -1,8 +1,8 @@
[[messages]]
-== Messages
+= Messages
[[messages-introduction]]
-=== Introduction
+== Introduction
Messages point out potential problems in the input program; some are
clearly problems (errors), but many more may depend on what the
@@ -14,7 +14,7 @@ some problem scenarios when compiling or doing load-time weaving, and
summarizes some of the more relevant messages.
[[messages-introduction-config]]
-==== Configuring Messages
+=== Configuring Messages
The compiler offers `-verbose`, `-warning`, and `-XLint` options when
invoked using the command-line, Ant, or embedded in an IDE. All options
@@ -85,19 +85,19 @@ warnings associated with the next line of code.
|===
[[messages-scenarios]]
-=== Message scenarios
+== Message scenarios
[[messages-scenarios-ct]]
-==== Compile-time weaving scenarios
+=== Compile-time weaving scenarios
[[messages-scenarios-ct-adviceNotWoven]]
-===== Advice not woven
+==== Advice not woven
This means that the pointcut for the advice did not match, and it should
be debugged as described in xref:pointcuts.adoc#pointcuts[Debugging Pointcuts].
[[messages-scenarios-ltw]]
-==== Load-time weaving scenarios
+=== Load-time weaving scenarios
You can use `META-INF/aop.xml` to control which messages are produced
during LTW. The following example will produce basic informational
@@ -129,7 +129,7 @@ applications each of which will typically have its own class loader.
....
[[messages-scenarios-ltw-adviceNotWoven]]
-===== Advice not woven
+==== Advice not woven
It is often difficult to determine, especially when using load-time
weaving (LTW), why advice has not been woven. Here is a quick guide to
@@ -164,7 +164,7 @@ If advice is woven at this join point you should get the corresponding
message.
[[messages-xlint]]
-=== Lint messages
+== Lint messages
The table below lists some useful `-Xlint` messages.
diff --git a/docs/modules/pdguide/pages/pointcuts.adoc b/docs/modules/pdguide/pages/pointcuts.adoc
index ecd964c57..e5199fc95 100644
--- a/docs/modules/pdguide/pages/pointcuts.adoc
+++ b/docs/modules/pdguide/pages/pointcuts.adoc
@@ -1,8 +1,8 @@
[[pointcuts]]
-== Debugging Pointcuts
+= Debugging Pointcuts
[[pointcuts-introduction]]
-=== Introduction
+== Introduction
This section describes how to write and debug pointcuts using the usual
approach of iteration and decomposition. New users are often stumped
@@ -14,11 +14,11 @@ break it down, particularly into parts that can be checked at
compile-time, can save a lot of time.
[[pointcuts-debugging]]
-=== Debugging pointcuts
+== Debugging pointcuts
Go at it top-down and then bottom-up.
-==== Top-down
+=== Top-down
Top-down, draft significant
aspects by first writing the comments to specify responsibilities.
@@ -30,7 +30,7 @@ semantic bridge to the plain-text meaning in a comment, e.g. `// when
the client passes only context into the library`. This gets you to a
point where you can debug the parts of the pointcut independently.
-==== Bottom-up
+=== Bottom-up
Bottom-up (to build each part), consider each primitive pointcut
designator (PCD), then the composition, and then any implicit
@@ -59,12 +59,12 @@ listed above). If compiles themselves take too long because of all the
AspectJ weaving, then try to only include the debugging aspect with the
prototype pointcut, and limit the scope using `within(..)`.
-=== Common pointcut mistakes
+== Common pointcut mistakes
There are some typical types of mistakes developers make when designing pointcuts.
Here are a few examples:
-==== Mistakes in primitive pointcuts
+=== Mistakes in primitive pointcuts
* `this(Foo) && execution(static * *(..))`: There is no `this` in a
static context, so `this()` or `target()` should not be used in a static
@@ -90,7 +90,7 @@ within `Foo`, so this won't pick out any overrides of `bar(..)`. Use
* `within(Foo)`: anonymous types are not known at weave-time to be
within the lexically-enclosing type (a limitation of Java bytecode).
-==== Mistakes in composition
+=== Mistakes in composition
* `call(* foo(Bar, Foo)) && args(Foo)`: This will never match. The
parameters in `args(..)` are position-dependent, so `args(Foo)` only
@@ -104,7 +104,7 @@ different kinds of join points (here, call or execution), use `||`.
E.g., to match both method-call and field-get join points, use
`call(* ...) || get(...)`.
-==== Mistakes in implicit advice constraints
+=== Mistakes in implicit advice constraints
* `after () returning (Foo foo) : ...`: after advice can bind the
returned object or exception thrown. That effectively acts like
@@ -112,7 +112,7 @@ returned object or exception thrown. That effectively acts like
based on the runtime type of the bound object, even though it is not
explicitly part of the pointcut.
-==== Mistakes in implementation requirements
+=== Mistakes in implementation requirements
* _ajc_ has to control the code for a join point in order to implement
the join point. This translates to an implicit `within({code under the
diff --git a/docs/modules/pdguide/pages/trace.adoc b/docs/modules/pdguide/pages/trace.adoc
index a752e0262..d9c9de1d9 100644
--- a/docs/modules/pdguide/pages/trace.adoc
+++ b/docs/modules/pdguide/pages/trace.adoc
@@ -1,8 +1,8 @@
[[trace]]
-== Tracing
+= Tracing
[[trace-introduction]]
-=== Introduction
+== Introduction
The AspectJ developers have instrumented the compiler/weaver with many
"trace" messages for their own debugging use. These remain in the
@@ -22,7 +22,7 @@ produce a trace of the compiler when the problem occurs instead. This
can then be attached to the bug report.
[[trace-configuration]]
-==== Configuring Tracing
+=== Configuring Tracing
When available (Java 5 or later) AspectJ will use the
http://java.sun.com/j2se/1.5.0/docs/guide/logging/index.html[java.util.logging]
@@ -72,7 +72,7 @@ Default: `false`.
|===
[[trace-examples]]
-==== Examples
+=== Examples
Using `-Dorg.aspectj.tracing.factory=default` to force AspectJ to use
its internal infrastructure, `-Dorg.aspectj.tracing.enabled=true` to