diff options
author | wisberg <wisberg> | 2005-03-10 08:39:07 +0000 |
---|---|---|
committer | wisberg <wisberg> | 2005-03-10 08:39:07 +0000 |
commit | 55e9ee4e8f3b61167244af23f686bfa977a3178f (patch) | |
tree | 8bde92f06aa043b0dd69bda54018b4b79c7bef6f /docs | |
parent | 83cda65860254f7de81dfe69feb85219a08d2bf4 (diff) | |
download | aspectj-55e9ee4e8f3b61167244af23f686bfa977a3178f.tar.gz aspectj-55e9ee4e8f3b61167244af23f686bfa977a3178f.zip |
no content changes - corrected xml. Using informaltable in ant to get pdf tables to work.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/devGuideDB/ajbrowser.xml | 33 | ||||
-rw-r--r-- | docs/devGuideDB/ajc.xml | 111 | ||||
-rw-r--r-- | docs/devGuideDB/antsupport.xml | 52 | ||||
-rw-r--r-- | docs/devGuideDB/devguide.xml | 20 |
4 files changed, 120 insertions, 96 deletions
diff --git a/docs/devGuideDB/ajbrowser.xml b/docs/devGuideDB/ajbrowser.xml index 7792fb0ea..491da7d15 100644 --- a/docs/devGuideDB/ajbrowser.xml +++ b/docs/devGuideDB/ajbrowser.xml @@ -3,6 +3,7 @@ <title>AspectJ Browser</title> <sect1 id="ajbrowser-intro"> + <title>Introduction</title> <para> AJBrowser presents a GUI for compiling programs with ajc and navigating crosscutting structure. @@ -106,10 +107,12 @@ (see label 1 in the graphic below). (If you get classpath or other errors, set up the global build options as described above.) - </para> + <inlinemediaobject> <imageobject> <imagedata fileref="ajbrowser-building.gif"/> </imageobject> + </inlinemediaobject> + </para> </sect2> </sect1> @@ -123,10 +126,12 @@ displayed in italics. Links to other structure nodes appear in blue below the association. If there is no corresponding source for the link it will appear light-blue. - </para> + <inlinemediaobject> <imageobject> <imagedata fileref="ajbrowser-building.gif"/> </imageobject> + </inlinemediaobject> + </para> <sect2> <title>Example: Exploring the "Spacewar" sample code </title> @@ -136,7 +141,7 @@ <listitem> <para>Launch <literal>ajbrowser</literal></para> </listitem> - <listitem> Choose "File -> Open" or click the "Open Build + <listitem> <para>Choose "File -> Open" or click the "Open Build Configuration" button (<inlinemediaobject> <imageobject> @@ -144,7 +149,7 @@ </imageobject> </inlinemediaobject>) and select the configuration file for debugging the spacewar example, in - <literal>examples/spacewar/debug.lst</literal>. + <literal>examples/spacewar/debug.lst</literal>.</para> </listitem> <listitem> <para>Click the "Build" button (<inlinemediaobject> @@ -176,9 +181,11 @@ </para> <para> - <imageobject> + <inlinemediaobject> + <imageobject> <imagedata fileref="ajbrowser-options.gif"/> </imageobject> + </inlinemediaobject>> </para> </listitem> @@ -187,17 +194,17 @@ left can display different orderings and granularity for structure: <itemizedlist> - <listitem> The package hierarchy view shows the traditional hierarchy - of package, class, and members. </listitem> + <listitem><para>The package hierarchy view shows the traditional hierarchy + of package, class, and members.</para></listitem> - <listitem> The inheritance view shows the hierarchy from topmost - parent classes through subclasses to members. </listitem> + <listitem><para>The inheritance view shows the hierarchy from topmost + parent classes through subclasses to members.</para></listitem> - <listitem> The crosscutting view shows the aspect members - and the code they affect. </listitem> + <listitem><para>The crosscutting view shows the aspect members + and the code they affect.</para></listitem> - <listitem> Additional buttons in the pane can be used to change the - granularity and filter out items. + <listitem><para>Additional buttons in the pane can be used to change the + granularity and filter out items.</para> </listitem> </itemizedlist> diff --git a/docs/devGuideDB/ajc.xml b/docs/devGuideDB/ajc.xml index 5eb56f15b..95b096649 100644 --- a/docs/devGuideDB/ajc.xml +++ b/docs/devGuideDB/ajc.xml @@ -1,12 +1,13 @@ <refentry id="ajc-ref" xreflabel="The ajc Command-line Reference"> - <refnamediv> + + <refnamediv> <refname>ajc</refname> - <refpurpose>compiler and bytecode weaver for the AspectJ and Java languages </refpurpose> - </refnamediv> + <refpurpose>compiler and bytecode weaver for the AspectJ and Java languages</refpurpose> + </refnamediv> <refsynopsisdiv> <cmdsynopsis> - <command>ajc</command> + <command>ajc</command> <arg><replaceable>Options</replaceable></arg> <group> <arg><replaceable>file...</replaceable></arg> @@ -15,7 +16,6 @@ </group> </cmdsynopsis> </refsynopsisdiv> - <refsect1 id="ajc" xreflabel="ajc"> <title>Description</title> @@ -38,7 +38,7 @@ extend to the end of the line. </para> - <para> + <para> <command>NB:</command> You must explicitly pass <command>ajc</command> all sources necessary for the compilation. When compiling source files containing aspects @@ -419,7 +419,8 @@ </refsect2> - <refsect2> <title>File names</title> + <refsect2> + <title>File names</title> <para>ajc accepts source files with either the <filename>.java</filename> extension or the <filename>.aj</filename> extension. We normally use @@ -432,23 +433,21 @@ <para>We'd like to discourage other means of mechanical distinction such as naming conventions or sub-packages in favor of the <filename>.aj</filename> extension.</para> - <para> <itemizedlist> - <listitem>Filename conventions are hard to enforce and lead to awkward names + <listitem><para>Filename conventions are hard to enforce and lead to awkward names for your aspects. Instead of <filename>TracingAspect.java</filename> we recommend using <filename>Tracing.aj</filename> (or just - <filename>Tracing.java</filename>) instead.</listitem> + <filename>Tracing.java</filename>) instead.</para></listitem> - <listitem>Sub-packages move aspects out of their natural place in a system + <listitem><para>Sub-packages move aspects out of their natural place in a system and can create an artificial need for privileged aspects. Instead of adding a sub-package like <filename>aspects</filename> we recommend using the <filename>.aj</filename> extension and including these files in your existing - packages instead.</listitem> + packages instead.</para></listitem> </itemizedlist> - </para> </refsect2> @@ -493,33 +492,30 @@ and may include other argfiles by @-reference. The following file <literal>sources.lst</literal> contains absolute and relative files and @-references: - <para><programlisting> + </para> + <programlisting> Gui.java /home/user/src/Library.java data/Repository.java data/Access.java @../../common/common.lst @/home/user/src/lib.lst -view/body/ArrayView.java</programlisting></para> - - Compile the files using either the -argfile or @ form: +view/body/ArrayView.java</programlisting> - <para><programlisting> + <para>Compile the files using either the -argfile or @ form:</para> + <programlisting> ajc -argfile sources.lst -ajc @sources.lst</programlisting></para> - </para> +ajc @sources.lst</programlisting> <para> Argfiles are also supported by jikes and javac, so you can use the files in hybrid builds. However, the support varies: </para> - <para> <itemizedlist> - <listitem>Only ajc accepts command-line options</listitem> - <listitem>Jikes and Javac do not accept internal @argfile references. - </listitem> - <listitem>Jikes and Javac only accept the @file form on the command line.</listitem> + <listitem><para>Only ajc accepts command-line options</para></listitem> + <listitem><para>Jikes and Javac do not accept internal @argfile references. + </para></listitem> + <listitem><para>Jikes and Javac only accept the @file form on the command line.</para></listitem> </itemizedlist> - </para> </example> <example id="examplebytecode"> @@ -578,61 +574,60 @@ ajc @sources.lst</programlisting></para> are "/". All commands are on one line. Adjust paths and commands to your environment as needed. -</para><para>Setup the path, classpath, and current directory: +</para><para>Setup the path, classpath, and current directory:</para> - <para><programlisting> + <programlisting> cd examples export ajrt=../lib/aspectjrt.jar export CLASSPATH="$ajrt" export PATH="../bin:$PATH" - </programlisting></para> + </programlisting> -</para><para>Build a read-only tracing library: - <para><programlisting> +<para>Build a read-only tracing library:</para> + <programlisting> ajc -argfile tracing/tracelib.lst -outjar tracelib.jar - </programlisting></para> + </programlisting> -</para><para>Build the application with tracing in one step: +<para>Build the application with tracing in one step:</para> - <para><programlisting> + <programlisting> ajc -aspectpath tracelib.jar -argfile tracing/notrace.lst -outjar tracedapp.jar - </programlisting></para> + </programlisting> -</para><para>Run the application with tracing: +<para>Run the application with tracing:</para> - <para><programlisting> + <programlisting> java -classpath "$ajrt;tracedapp.jar;tracelib.jar" tracing.ExampleMain - </programlisting></para> + </programlisting> -</para><para>Build the application with tracing from binaries in two steps: - <listitem><para> -(a) Build the application classes (using javac for demonstration's sake): - <para><programlisting> +<para>Build the application with tracing from binaries in two steps:</para> + <itemizedlist><listitem><para> +(a) Build the application classes (using javac for demonstration's sake):</para> + <programlisting> mkdir classes javac -d classes tracing/*.java jar cfM app.jar -C classes . - </programlisting></para> + </programlisting> - </para></listitem> + </listitem> <listitem><para> -(b) Build the application with tracing: - <para><programlisting> +(b) Build the application with tracing:</para> + <programlisting> ajc -injars app.jar -aspectpath tracelib.jar -outjar tracedapp.jar - </programlisting></para> - </para></listitem> + </programlisting> + </listitem></itemizedlist> -</para><para>Run the application with tracing (same as above): +<para>Run the application with tracing (same as above):</para> - <para><programlisting> + <programlisting> java -classpath "$ajrt;tracedapp.jar;tracelib.jar" tracing.ExampleMain - </programlisting></para> + </programlisting> -</para><para>Run the application without tracing: +<para>Run the application without tracing:</para> - <para><programlisting> + <programlisting> java -classpath "app.jar" tracing.ExampleMain - </programlisting></para> -</para> + </programlisting> </example> @@ -735,9 +730,3 @@ File0;File1[Number1];File2[Number2] ... :LineNumber </refsect1> </refentry> - -<!-- Local variables: --> -<!-- fill-column: 79 --> -<!-- sgml-local-ecat-files: devguide.ced --> -<!-- sgml-parent-document:("devguide.sgml" "book" "refentry") --> -<!-- End: --> diff --git a/docs/devGuideDB/antsupport.xml b/docs/devGuideDB/antsupport.xml index 4ff2715d9..71d923563 100644 --- a/docs/devGuideDB/antsupport.xml +++ b/docs/devGuideDB/antsupport.xml @@ -140,8 +140,14 @@ </para> <!-- . . . . . . . . . . . . . . . . iajc options table --> - <table> - <title>AjcTask (iajc) options for specifying sources</title> + <!-- table (and caption/title) not supported by fop --> + <para> + <emphasis role="strong"> + AjcTask (iajc) options for specifying sources + </emphasis> + </para> + <informaltable> + <tgroup cols="2"> <thead> <row> @@ -242,10 +248,14 @@ </row> </tbody> </tgroup> - </table> + </informaltable> - <table> - <title>AjcTask (iajc) options for specifying output</title> + <para> + <emphasis role="strong"> + AjcTask (iajc) options for specifying output + </emphasis> + </para> + <informaltable> <tgroup cols="2"> <thead> <row> @@ -297,10 +307,14 @@ </row> </tbody> </tgroup> - </table> + </informaltable> - <table> - <title>AjcTask (iajc) options for specifying compiler behavior</title> + <para> + <emphasis role="strong"> + AjcTask (iajc) options for specifying compiler behavior + </emphasis> + </para> + <informaltable> <tgroup cols="2"> <thead> <row> @@ -384,10 +398,14 @@ </row> </tbody> </tgroup> - </table> + </informaltable> - <table> - <title>AjcTask (iajc) options for specifying compiler side-effects and messages</title> + <para> + <emphasis role="strong"> + AjcTask (iajc) options for specifying compiler side-effects and messages + </emphasis> + </para> + <informaltable> <tgroup cols="2"> <thead> <row> @@ -490,11 +508,15 @@ </row> </tbody> </tgroup> - </table> + </informaltable> - <table> - <title>AjcTask (iajc) options for specifying Eclipse compiler options</title> + <para> + <emphasis role="strong"> + AjcTask (iajc) options for specifying Eclipse compiler options + </emphasis> + </para> + <informaltable> <tgroup cols="2"> <thead> <row> @@ -630,7 +652,7 @@ </row> </tbody> </tgroup> - </table> + </informaltable> <!-- . . . . . . . . . . . . . . . . iajc options table --> </sect2> diff --git a/docs/devGuideDB/devguide.xml b/docs/devGuideDB/devguide.xml index 0bf3316c6..691567609 100644 --- a/docs/devGuideDB/devguide.xml +++ b/docs/devGuideDB/devguide.xml @@ -27,7 +27,7 @@ <legalnotice> <para>Copyright (c) 1998-2001 Xerox Corporation, 2002 Palo Alto Research Center, Incorporated, - 2003 Contributors. + 2003-2005 Contributors. All rights reserved. </para> </legalnotice> @@ -47,18 +47,18 @@ http://eclipse.org/aspectj</ulink>. <!-- <itemizedlist> - <listitem><ulink url="../progguide/index.html">The - AspectJ Programming Guide</ulink> + <listitem><para><ulink url="../progguide/index.html">the + AspectJ Programming Guide</ulink></para> </listitem> - <listitem>the + <listitem><para>the documentation available with the AspectJ support available for various integrated development environments (e.g., Eclipse, Emacs, - JBuilder, and NetBeans) + JBuilder, and NetBeans)</para> </listitem> - <listitem>the most-recent documentation available from + <listitem><para>the most-recent documentation available from the AspectJ project page, at <ulink url="http://eclipse.org/aspectj"> - http://eclipse.org/aspectj</ulink>. + http://eclipse.org/aspectj</ulink>.</para> </listitem> </itemizedlist> --> @@ -67,6 +67,12 @@ </bookinfo> <reference> + <referenceinfo> + <abstract> + <title>Summary of command-line tools</title><para/> + </abstract> + </referenceinfo> + <title>Command-line tools</title> &ajc; &ajdoc; </reference> |