diff options
author | aclement <aclement> | 2006-10-25 09:24:00 +0000 |
---|---|---|
committer | aclement <aclement> | 2006-10-25 09:24:00 +0000 |
commit | e4a441b93c2f1a644784af90d8256f0d6c194b4c (patch) | |
tree | c44d730a218772f448b7c401421997f6463cff7a /docs | |
parent | 7b40e7e3e4b68d6b0334f5643931e00f06881cdd (diff) | |
download | aspectj-e4a441b93c2f1a644784af90d8256f0d6c194b4c.tar.gz aspectj-e4a441b93c2f1a644784af90d8256f0d6c194b4c.zip |
ajdoc patches 148906REMOVING_ASM
Diffstat (limited to 'docs')
-rw-r--r-- | docs/devGuideDB/ajc.xml | 2 | ||||
-rw-r--r-- | docs/devGuideDB/ajdoc.xml | 40 |
2 files changed, 18 insertions, 24 deletions
diff --git a/docs/devGuideDB/ajc.xml b/docs/devGuideDB/ajc.xml index 30ca3b901..a370b8e99 100644 --- a/docs/devGuideDB/ajc.xml +++ b/docs/devGuideDB/ajc.xml @@ -55,7 +55,7 @@ on the inpath and rebuild.) </para> - <refsect2> + <refsect2 id="ajc_options" xreflabel="ajc_options"> <title>Options</title> <variablelist> diff --git a/docs/devGuideDB/ajdoc.xml b/docs/devGuideDB/ajdoc.xml index cd6ad011d..d2a763d59 100644 --- a/docs/devGuideDB/ajdoc.xml +++ b/docs/devGuideDB/ajdoc.xml @@ -1,7 +1,7 @@ <refentry id="ajdoc-ref" xreflabel="The ajdoc Command-line Reference"> <refnamediv> <refname>ajdoc</refname> - <refpurpose>generate HTML API documentation, including crosscutting structure (early-access) + <refpurpose>generate HTML API documentation, including crosscutting structure </refpurpose> </refnamediv> @@ -32,23 +32,20 @@ <arg>@<replaceable>file...</replaceable></arg> <arg>-argfile <replaceable>file...</replaceable></arg> </group> + <arg choice="opt"> + <replaceable>ajc options</replaceable> + </arg> </cmdsynopsis> </refsynopsisdiv> <refsect1> <title>Description</title> <para> - Similar to <command>javadoc</command>, - <command>ajdoc</command> renders HTML documentation for pointcuts, - advice, and inter-type declarations, as - well as the Java constructs that Javadoc renders. - <command>ajdoc</command> also links - advice from members affected by the advice and - the inter-type declaration for members declared from aspects. - The aspect will be fully documented, - as will your target classes, including links to any - advice or declarations that affect the class. - That means, for example, that + <command>ajdoc</command> renders HTML documentation for AspectJ + constructs as well as the Java constructs that + <command>javadoc</command> renders. + In addition <command>ajdoc</command> displays the crosscutting + nature in the form of links. That means, for example, that you can see everything affecting a method when reading the documentation for the method. </para> @@ -68,8 +65,8 @@ As with <command>ajc</command> (but unlike <command>javadoc</command>), you pass <command>ajdoc</command> all your aspect source files and any files containing types affected by the aspects; - it's often easiest to just pass all the <filename>.java</filename> files - in your system. + it's often easiest to just pass all the <filename>.java</filename> + and <filename>.aj</filename> files in your system. Unlike <command>ajc</command>, <command>ajdoc</command> will try to find package sources using the specified sourcepath if you list packages on the command line. @@ -90,6 +87,12 @@ for details on the text file format. </para> + <para> + <command>ajdoc</command> honours <command>ajc</command> options. See + the <link linkend="ajc_options">ajc documentation</link> for details on + these options. + </para> + <para> <command>ajdoc</command> currently requires the <filename>tools.jar</filename> from J2SE 1.3 to be on the classpath. @@ -102,15 +105,6 @@ </refsect1> <refsect1> - <title>Known limitations</title> - <para> - <command>ajdoc</command> documents advice and pointcut members, shows where advice applies and - links affected members back to the advice. - It currently does not document or add structural links for any inter-type declarations or other declare forms. - </para> - </refsect1> - - <refsect1> <title>Examples</title> <example id="ajdocdocumentingspacewar"> <!-- docbook bug - rendering this as example 4? --> <title>Documenting Spacewar</title> |