diff options
| author | mkersten <mkersten> | 2004-04-14 18:39:36 +0000 |
|---|---|---|
| committer | mkersten <mkersten> | 2004-04-14 18:39:36 +0000 |
| commit | e1fb8059ea0aaf45df285d39577ac7c52ed65099 (patch) | |
| tree | fc5c0e1e57ae04041d1bc2fea569894f9df07554 | |
| parent | d3f22340b84c9254f7893e71fedb40ac7467abf9 (diff) | |
| download | aspectj-e1fb8059ea0aaf45df285d39577ac7c52ed65099.tar.gz aspectj-e1fb8059ea0aaf45df285d39577ac7c52ed65099.zip | |
Updates to ajdoc docs and notes on current limitations.
| -rw-r--r-- | docs/devGuideDB/ajdoc.xml | 10 | ||||
| -rw-r--r-- | docs/dist/doc/README-12.html | 16 |
2 files changed, 23 insertions, 3 deletions
diff --git a/docs/devGuideDB/ajdoc.xml b/docs/devGuideDB/ajdoc.xml index be13c897c..6a64e6d7e 100644 --- a/docs/devGuideDB/ajdoc.xml +++ b/docs/devGuideDB/ajdoc.xml @@ -100,6 +100,16 @@ </para> </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? --> diff --git a/docs/dist/doc/README-12.html b/docs/dist/doc/README-12.html index caf0666ab..4aff86ebc 100644 --- a/docs/dist/doc/README-12.html +++ b/docs/dist/doc/README-12.html @@ -90,8 +90,7 @@ together with <a href="porting.html">porting.html</a>. <p>AspectJ 1.2 contains two important changes to the supporting tools:</p> <ul> - <li><a href="#AJDOC">ajdoc</a> is back. - <li>A sample script is supplied for <a href="#LTW">load-time weaving</a> from the command-line. + <li><a href="#AJDOC">ajdoc</a> is back<li>A sample script is supplied for <a href="#LTW">load-time weaving</a> from the command-line. </ul> <!-- ============================== --> <hr> @@ -120,7 +119,8 @@ together with <a href="porting.html">porting.html</a>. AjBrowser tool that benefits from all the enhancements made in the 1.2 compiler.</p> <p>The 1.2 release of AspectJ also lays a lot of the groundwork for a much better AspectJ - IDE experience that we hope to surface initially through AJDT. Amongst the many improvements, we + IDE experience that we hope to surface initially through AJDT (AspectJ support + for Eclipse). Amongst the many improvements, we will have full eager parsing support that avoids the need to keep the whole structure model of a project in memory, hopefully making AJDT much less memory hungry and much slicker to use. For more details see the <a href="http://www.eclipse.org/ajdt"> @@ -428,6 +428,16 @@ together with <a href="porting.html">porting.html</a>. the AspectJ distribution. The <code>ajdoc</code> tool produces regular javadoc that also shows advises and advised by relationships next to methods and advice. A future enhancement will show inter-type declarations in the target class too. </p> +<p><b>Known limitations: </b>Please note that <code>ajdoc</code> 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.</p> +<p>Run the "ajdoc.bat" script just + as you run javadoc. For a list of accepted parameters run "ajdoc + -help". For example, to document everything in the Spacewar example + run:<br> + <tt>> cd examples<br> + > ajdoc -d doc -private spacewar coordination</tt></p> <p><code>ajdoc</code> sample output for an aspect source file:</p> |