diff options
| author | mkersten <mkersten> | 2004-07-23 19:38:29 +0000 |
|---|---|---|
| committer | mkersten <mkersten> | 2004-07-23 19:38:29 +0000 |
| commit | 77a8d52969465ee104317127c7a4bf5859ff147b (patch) | |
| tree | aa3b8f89eb5492c1fe840f12cd89773c2acc4493 /asm | |
| parent | 8dc08453232f9b4c1572ad0feb60979fb07336fe (diff) | |
| download | aspectj-77a8d52969465ee104317127c7a4bf5859ff147b.tar.gz aspectj-77a8d52969465ee104317127c7a4bf5859ff147b.zip | |
Expanded javadocs describing examples of ASM usage.
Diffstat (limited to 'asm')
| -rw-r--r-- | asm/src/org/aspectj/asm/AsmManager.java | 5 | ||||
| -rw-r--r-- | asm/src/org/aspectj/asm/IRelationshipMap.java | 9 |
2 files changed, 11 insertions, 3 deletions
diff --git a/asm/src/org/aspectj/asm/AsmManager.java b/asm/src/org/aspectj/asm/AsmManager.java index e31f13f62..91a166af6 100644 --- a/asm/src/org/aspectj/asm/AsmManager.java +++ b/asm/src/org/aspectj/asm/AsmManager.java @@ -20,6 +20,11 @@ import org.aspectj.asm.internal.*; import org.aspectj.bridge.ISourceLocation; /** + * The Abstract Structure Model (ASM) represents the containment hierarchy and crossccutting + * structure map for AspectJ programs. It is used by IDE views such as the document outline, + * and by other tools such as ajdoc to show both AspectJ declarations and crosscutting links, + * such as which advice affects which join point shadows. + * * @author Mik Kersten */ public class AsmManager { diff --git a/asm/src/org/aspectj/asm/IRelationshipMap.java b/asm/src/org/aspectj/asm/IRelationshipMap.java index 7fbd97c0c..7eb31335f 100644 --- a/asm/src/org/aspectj/asm/IRelationshipMap.java +++ b/asm/src/org/aspectj/asm/IRelationshipMap.java @@ -20,9 +20,12 @@ import java.util.List; /** * Maps from a program element handles to a list of relationships between that element * and othe program elements. Each element in the list or relationships is - * uniquely identified by a kind and a relationship name. + * uniquely identified by a kind and a relationship name. For example, the advice affecting + * a particular shadow (e.g. method call) can be retrieved by calling <CODE>get</CODE> on + * the handle for that method. Symmetrically the method call shadows that an advice affects + * can be retrieved. * - * The elemetns can be stored and looked up as IProgramElement(s), in which cases the + * The elements can be stored and looked up as IProgramElement(s), in which cases the * element corresponding to the handle is looked up in the containment hierarchy. * * put/get methods taking IProgramElement as a parameter are for convenience only. @@ -43,7 +46,7 @@ public interface IRelationshipMap extends Serializable { public List/*IRelationship*/ get(String handle); /** - * Return a relationship matching the kind and name for the given element. + * Return a relationship matching the kind and name for the given element. * * @return null if the relationship is not found. */ |