avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcconn...@apache.org
Subject svn commit: rev 21551 - avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication
Date Mon, 21 Jun 2004 17:38:45 GMT
Author: mcconnell
Date: Mon Jun 21 10:38:44 2004
New Revision: 21551

Modified:
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication/index.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication/javadoc.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication/publish.xml
Log:
more on publishing

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication/index.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication/index.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication/index.xml	Mon
Jun 21 10:38:44 2004
@@ -9,6 +9,8 @@
   <body>
     <section name="Publication Tasks">
       <p>
+      Publication tasks deal with the generation of project document, 
+      javadoc production, and publication into a common doc repository.
       </p>
     </section>
   </body>

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication/javadoc.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication/javadoc.xml
(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication/javadoc.xml
Mon Jun 21 10:38:44 2004
@@ -9,10 +9,50 @@
   <body>
     <section name="Javadoc Task">
       <p>
+      The javadoc task provides support for automatic generation of 
+      consolidated javadoc taking into account the source directories of
+      dependent projects.  If the target of javadoc generation supports
+      staged classloader defintions (API, SPI, IMPL) - then javadoc 
+      will be generated for each set. The task supports local and remote 
+      link declarations (see source for additional details).
       </p>
+      <p>
+      The following declarations instruct the current build to invoke
+      javadoc generation on an identified project using the id attribute.
+      The title attribute sets the javadoc title.
+      </p>
 <source><![CDATA[
-    <x:javadoc/>
+<x:javadoc title="Merlin Runtime" id="avalon-runtime">
+  <x:link href="http://java.sun.com/j2se/1.4/docs/api" />
+</x:javadoc>
 ]]></source>
+
+      <p><i>Typical output of the javadoc task:</i></p>
+<pre>javadoc:
+[x:javadoc] Generating: Merlin Runtime, Version 3.3.0 : API
+[x:javadoc] link: http://java.sun.com/j2se/1.4/docs/api
+[x:javadoc] Adding src path: F:\dev\avalon\runtime\framework\api\target\build\main
+[x:javadoc] Adding src path: F:\dev\avalon\runtime\util\lifecycle\target\build\main
+  [javadoc] Generating Javadoc
+  [javadoc] Javadoc execution
+  [javadoc] Loading source files for package org.apache.avalon.framework...
+  [javadoc] Loading source files for package org.apache.avalon.framework.activity...
+  [javadoc] Loading source files for package org.apache.avalon.framework.configuration...
+  [javadoc] Loading source files for package org.apache.avalon.framework.context...
+  [javadoc] Loading source files for package org.apache.avalon.framework.logger...
+  [javadoc] Loading source files for package org.apache.avalon.framework.parameters...
+  [javadoc] Loading source files for package org.apache.avalon.framework.service...
+  [javadoc] Loading source files for package org.apache.avalon.framework.thread...
+  [javadoc] Loading source files for package org.apache.avalon.lifecycle...
+  [javadoc] Constructing Javadoc information...
+  [javadoc] Standard Doclet version 1.4.2_04
+  [javadoc] Building tree for all the packages and classes...
+  [javadoc] Building index for all the packages and classes...
+  [javadoc] Building index for all classes...
+
+  [javadoc] Generating F:\dev\avalon\central\system\.docs\avalon\runtime\3.3.0\api\stylesheet.css...
+
+  ....</pre>
     </section>
   </body>
 

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication/publish.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication/publish.xml
(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/publication/publish.xml
Mon Jun 21 10:38:44 2004
@@ -7,12 +7,21 @@
   </properties> 
 
   <body>
-    <section name="Xdoc Task">
+    <section name="Publish Task">
       <p>
+      The publish task copies documentation content from ${basedir}/target/docs
+      into the doc repository under the relative path [group]/[name]/[version].
+      The relative path can be overriden using the path attribute as shown in 
+      the following example of a project publishing into the root of the document
+      repository.
       </p>
 <source><![CDATA[
-    <x:publish/>
+<x:publish path="."/>
 ]]></source>
+
+<pre>site:
+     [copy] Copying 405 files to F:\dev\avalon\central\system\.docs</pre>
+
     </section>
   </body>
 

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org


Mime
View raw message