summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwisberg <wisberg>2005-06-08 23:29:58 +0000
committerwisberg <wisberg>2005-06-08 23:29:58 +0000
commit944c8052d19b03bce8e084fe6a7a6a4e06847b37 (patch)
treeeeffa8fb861c0c9c0624f674d0ce22870dd75465
parent747a6e82fe2c5df1db367eac9da612a10d6b4922 (diff)
downloadaspectj-944c8052d19b03bce8e084fe6a7a6a4e06847b37.tar.gz
aspectj-944c8052d19b03bce8e084fe6a7a6a4e06847b37.zip
revamped javadoc - separated runtime and weaver, handling offline execution
-rw-r--r--docs/build.xml52
-rw-r--r--docs/dist/doc/index.html5
-rw-r--r--docs/docs.build.properties30
-rw-r--r--docs/jdk15-packages.txt166
4 files changed, 232 insertions, 21 deletions
diff --git a/docs/build.xml b/docs/build.xml
index 9a8397434..0f5fce4dc 100644
--- a/docs/build.xml
+++ b/docs/build.xml
@@ -15,10 +15,10 @@
<project name="docs" default="dist" basedir=".">
<property name="project.name" value="build-docs" />
-
+
<target name="product" depends="local-dist" />
<target name="clean"
- depends="clean-directories,clean-doc-directories"
+ depends="clean-doc-directories"
/>
<!-- ===================================================================== -->
@@ -26,7 +26,7 @@
<!-- ===================================================================== -->
<import file="${basedir}/../build/build-properties.xml"/>
-
+
<target name="init" depends="init-properties,init-directories">
<property name="docs.src.pattern"
@@ -234,20 +234,34 @@
<target name="api"
depends="init"
- description="javadoc for AspectJ lang, lang.reflect and org.aspectj.weaver.tools"
+ description="javadoc for AspectJ runtime and weaver"
>
- <delete dir="${docs.dist.dir}/doc/api" />
- <mkdir dir="${docs.dist.dir}/doc/api" />
- <javadoc sourcepath="${aspectj.modules.dir}/runtime/src;${aspectj.modules.dir}/weaver/src"
- destdir="${docs.dist.dir}/doc/api"
- windowtitle="AspectJ(tm) runtime API"
- link="http://java.sun.com/j2se/1.4.2/docs/api"
- classpath="${aspectj.modules.dir}/asm/bin;${aspectj.modules.dir}/bridge/bin;${aspectj.modules.dir}/util/bin;${aspectj.modules.dir}/lib/bcel/bcel.jar"
- packagenames="org.aspectj.lang,org.aspectj.lang.reflect,org.aspectj.weaver.tools"
- />
- <!-- note: link ineffective at avoiding see tag warning -->
+ <property file="${docs.src.dir}/docs.build.properties" />
+ <delete quiet="on">
+ <fileset dir="${docs.dist.dir}/doc" includes="*api/*" />
+ </delete>
+ <aspectj-javadoc module="runtime" />
+ <aspectj-javadoc module="weaver" />
</target>
+ <macrodef name="aspectj-javadoc">
+ <attribute name="module" />
+ <sequential>
+ <mkdir dir="${docs.dist.dir}/doc/@{module}-api" />
+ <javadoc sourcepath="${@{module}.sourcepath}"
+ destdir="${docs.dist.dir}/doc/@{module}-api"
+ windowtitle="AspectJ(tm) @{module} API"
+ classpath="${@{module}.classpath}"
+ packagenames="${@{module}.packagenames}"
+ >
+ <link offline="true"
+ href="http://java.sun.com/j2se/1.5/docs/api"
+ packagelistLoc="${docs.src.dir}/jdk15-packages.txt"
+ />
+ </javadoc>
+ </sequential>
+ </macrodef>
+
<target name="faq" depends="init">
<antcall target="xml-html">
<param name="xml-source-dir"
@@ -261,7 +275,7 @@
<param name="xml-target-file"
value="${docs.dist.dir}/doc/faq.html"
/>
- <param name="xml-html-stylesheet" value="aspectj-faq.css" />
+ <param name="xml-html-stylesheet" value="aspectj-faq.css" />
</antcall>
</target>
@@ -269,8 +283,8 @@
<antcall target="build-guide">
<param name="guide.dir" value="progGuideDB" />
<param name="guide.name" value="progguide" />
- <param name="xml-html-copy"
- value="dd_arrow.gif,aspects.gif,figureUML.gif,overview.gif,telecom.gif,aspectj-docs.css"/>
+ <param name="xml-html-copy"
+ value="dd_arrow.gif,aspects.gif,figureUML.gif,overview.gif,telecom.gif,aspectj-docs.css"/>
</antcall>
</target>
@@ -278,8 +292,8 @@
<antcall target="build-guide">
<param name="guide.dir" value="adk15ProgGuideDB" />
<param name="guide.name" value="adk15notebook" />
- <param name="xml-html-copy"
- value="dd_arrow.gif,aspectj-docs.css"/>
+ <param name="xml-html-copy"
+ value="dd_arrow.gif,aspectj-docs.css"/>
</antcall>
</target>
diff --git a/docs/dist/doc/index.html b/docs/dist/doc/index.html
index 894dff6d0..5827eb068 100644
--- a/docs/dist/doc/index.html
+++ b/docs/dist/doc/index.html
@@ -25,7 +25,7 @@
<a href="adk15notebook/index.html">AspectJ 5 Developer's Notebook</a>,
<a href="progguide/index.html">programming</a> and
<a href="devguide/index.html">development</a> guides,
- <a href="api/index.html">API</a> and
+ <a href="runtime-api/index.html">API</a> and
<a href="examples/">example code</a>.
</td></tr>
<tr><td><a href="#distributions">distributions</a></td><td>
@@ -106,10 +106,11 @@
</td>
</tr>
-<tr> <td><a href="api/index.html">AspectJ API</a>
+<tr> <td><a href="runtime-api/index.html">AspectJ API</a>
</td>
<td>API documentation for AspectJ runtime classes. <tt>JoinPoint</tt>
shows the state automatically available at each join point.
+ See also the <a href="weaver-api/index.html">Weaver API</a>
</td> </tr>
<tr> <td><a href="faq.html"> FAQ</a>
diff --git a/docs/docs.build.properties b/docs/docs.build.properties
new file mode 100644
index 000000000..2c756edd7
--- /dev/null
+++ b/docs/docs.build.properties
@@ -0,0 +1,30 @@
+runtime.packagenames=\
+org.aspectj.lang,org.aspectj.lang.reflect,\
+org.aspectj.runtime.reflect
+
+runtime.sourcepath=\
+${aspectj.modules.dir}/runtime/src
+
+runtime.classpath=
+
+weaver.packagenames=\
+org.aspectj.weaver.tools,\
+org.aspectj.weaver.loadtime,\
+org.aspectj.weaver.loadtime.definition
+
+weaver.sourcepath=\
+${aspectj.modules.dir}/weaver/src;\
+${aspectj.modules.dir}/loadtime/src
+
+weaver.classpath=\
+${aspectj.modules.dir}/lib/bcel/bcel.jar;\
+${aspectj.modules.dir}/asm/bin;\
+${aspectj.modules.dir}/bridge/bin;\
+${aspectj.modules.dir}/runtime/bin;\
+${aspectj.modules.dir}/util/bin;\
+${aspectj.modules.dir}/testing-util/bin;\
+${aspectj.modules.dir}/aj-build/jars/asm.jar;\
+${aspectj.modules.dir}/aj-build/jars/bridge.jar;\
+${aspectj.modules.dir}/aj-build/jars/runtime.jar;\
+${aspectj.modules.dir}/aj-build/jars/util.jar;\
+${aspectj.modules.dir}/aj-build/jars/testing-util.jar;\
diff --git a/docs/jdk15-packages.txt b/docs/jdk15-packages.txt
new file mode 100644
index 000000000..48783362e
--- /dev/null
+++ b/docs/jdk15-packages.txt
@@ -0,0 +1,166 @@
+java.applet
+java.awt
+java.awt.color
+java.awt.datatransfer
+java.awt.dnd
+java.awt.event
+java.awt.font
+java.awt.geom
+java.awt.im
+java.awt.im.spi
+java.awt.image
+java.awt.image.renderable
+java.awt.print
+java.beans
+java.beans.beancontext
+java.io
+java.lang
+java.lang.annotation
+java.lang.instrument
+java.lang.management
+java.lang.ref
+java.lang.reflect
+java.math
+java.net
+java.nio
+java.nio.channels
+java.nio.channels.spi
+java.nio.charset
+java.nio.charset.spi
+java.rmi
+java.rmi.activation
+java.rmi.dgc
+java.rmi.registry
+java.rmi.server
+java.security
+java.security.acl
+java.security.cert
+java.security.interfaces
+java.security.spec
+java.sql
+java.text
+java.util
+java.util.concurrent
+java.util.concurrent.atomic
+java.util.concurrent.locks
+java.util.jar
+java.util.logging
+java.util.prefs
+java.util.regex
+java.util.zip
+javax.accessibility
+javax.activity
+javax.crypto
+javax.crypto.interfaces
+javax.crypto.spec
+javax.imageio
+javax.imageio.event
+javax.imageio.metadata
+javax.imageio.plugins.bmp
+javax.imageio.plugins.jpeg
+javax.imageio.spi
+javax.imageio.stream
+javax.management
+javax.management.loading
+javax.management.modelmbean
+javax.management.monitor
+javax.management.openmbean
+javax.management.relation
+javax.management.remote
+javax.management.remote.rmi
+javax.management.timer
+javax.naming
+javax.naming.directory
+javax.naming.event
+javax.naming.ldap
+javax.naming.spi
+javax.net
+javax.net.ssl
+javax.print
+javax.print.attribute
+javax.print.attribute.standard
+javax.print.event
+javax.rmi
+javax.rmi.CORBA
+javax.rmi.ssl
+javax.security.auth
+javax.security.auth.callback
+javax.security.auth.kerberos
+javax.security.auth.login
+javax.security.auth.spi
+javax.security.auth.x500
+javax.security.cert
+javax.security.sasl
+javax.sound.midi
+javax.sound.midi.spi
+javax.sound.sampled
+javax.sound.sampled.spi
+javax.sql
+javax.sql.rowset
+javax.sql.rowset.serial
+javax.sql.rowset.spi
+javax.swing
+javax.swing.border
+javax.swing.colorchooser
+javax.swing.event
+javax.swing.filechooser
+javax.swing.plaf
+javax.swing.plaf.basic
+javax.swing.plaf.metal
+javax.swing.plaf.multi
+javax.swing.plaf.synth
+javax.swing.table
+javax.swing.text
+javax.swing.text.html
+javax.swing.text.html.parser
+javax.swing.text.rtf
+javax.swing.tree
+javax.swing.undo
+javax.transaction
+javax.transaction.xa
+javax.xml
+javax.xml.datatype
+javax.xml.namespace
+javax.xml.parsers
+javax.xml.transform
+javax.xml.transform.dom
+javax.xml.transform.sax
+javax.xml.transform.stream
+javax.xml.validation
+javax.xml.xpath
+org.ietf.jgss
+org.omg.CORBA
+org.omg.CORBA.DynAnyPackage
+org.omg.CORBA.ORBPackage
+org.omg.CORBA.TypeCodePackage
+org.omg.CORBA.portable
+org.omg.CORBA_2_3
+org.omg.CORBA_2_3.portable
+org.omg.CosNaming
+org.omg.CosNaming.NamingContextExtPackage
+org.omg.CosNaming.NamingContextPackage
+org.omg.Dynamic
+org.omg.DynamicAny
+org.omg.DynamicAny.DynAnyFactoryPackage
+org.omg.DynamicAny.DynAnyPackage
+org.omg.IOP
+org.omg.IOP.CodecFactoryPackage
+org.omg.IOP.CodecPackage
+org.omg.Messaging
+org.omg.PortableInterceptor
+org.omg.PortableInterceptor.ORBInitInfoPackage
+org.omg.PortableServer
+org.omg.PortableServer.CurrentPackage
+org.omg.PortableServer.POAManagerPackage
+org.omg.PortableServer.POAPackage
+org.omg.PortableServer.ServantLocatorPackage
+org.omg.PortableServer.portable
+org.omg.SendingContext
+org.omg.stub.java.rmi
+org.w3c.dom
+org.w3c.dom.bootstrap
+org.w3c.dom.events
+org.w3c.dom.ls
+org.xml.sax
+org.xml.sax.ext
+org.xml.sax.helpers