avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcconn...@apache.org
Subject svn commit: rev 21374 - in avalon/trunk: runtime/composition/impl/src/java/org/apache/avalon/composition/model/impl runtime/framework/api/src/java/org/apache/avalon/framework/configuration runtime/framework/legacy runtime/util/extension runtime/util/extension/api/src/java/org/apache/avalon/extension runtime/util/extension/api/src/java/org/apache/avalon/extension/manager runtime/util/extension/impl/src/java/org/apache/avalon/extension/manager/impl tools/magic/src/main/org/apache/avalon/tools/tasks
Date Thu, 17 Jun 2004 04:38:24 GMT
Author: mcconnell
Date: Wed Jun 16 21:38:23 2004
New Revision: 21374

Added:
   avalon/trunk/runtime/util/extension/build.properties   (contents, props changed)
   avalon/trunk/runtime/util/extension/build.xml
Modified:
   avalon/trunk/runtime/composition/impl/src/java/org/apache/avalon/composition/model/impl/DefaultClassLoaderContext.java
   avalon/trunk/runtime/framework/api/src/java/org/apache/avalon/framework/configuration/Configuration.java
   avalon/trunk/runtime/framework/legacy/   (props changed)
   avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/Extension.java
   avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/Specification.java
   avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/manager/package.html
   avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/package.html
   avalon/trunk/runtime/util/extension/impl/src/java/org/apache/avalon/extension/manager/impl/package.html
   avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/tasks/JavadocTask.java
Log:
A few minor updates to sources across avalon to eliminate javadoc warnings. Secondly, updates
to the javadoc task to enable a parameterized title.

Modified: avalon/trunk/runtime/composition/impl/src/java/org/apache/avalon/composition/model/impl/DefaultClassLoaderContext.java
==============================================================================
--- avalon/trunk/runtime/composition/impl/src/java/org/apache/avalon/composition/model/impl/DefaultClassLoaderContext.java
(original)
+++ avalon/trunk/runtime/composition/impl/src/java/org/apache/avalon/composition/model/impl/DefaultClassLoaderContext.java
Wed Jun 16 21:38:23 2004
@@ -124,9 +124,7 @@
     *
     * @param logger the logging channel to assign to the classloader model
     * @param system the system context
-    * @param repository a local repository
-    * @param base the system base directory
-    * @param parent the parent classloader
+    * @param parent the parent classloader
     * @param directive the classloader directive
     */
     public DefaultClassLoaderContext( 
@@ -142,9 +140,7 @@
     *
     * @param logger the logging channel to assign to the classloader model
     * @param system the system context
-    * @param repository a local repository
-    * @param base the system base directory
-    * @param parent the parent classloader
+    * @param parent the parent classloader
     * @param packages the set of optional packages established under 
     *    current classloader chain
     * @param manager the optional extions package manager established 
@@ -152,6 +148,7 @@
     * @param types the parent type manager
     * @param services the parent service manager
     * @param directive the classloader directive
+    * @param implied url array added though implication
     */
     public DefaultClassLoaderContext( 
       Logger logger, SystemContext system, 

Modified: avalon/trunk/runtime/framework/api/src/java/org/apache/avalon/framework/configuration/Configuration.java
==============================================================================
--- avalon/trunk/runtime/framework/api/src/java/org/apache/avalon/framework/configuration/Configuration.java
(original)
+++ avalon/trunk/runtime/framework/api/src/java/org/apache/avalon/framework/configuration/Configuration.java
Wed Jun 16 21:38:23 2004
@@ -28,16 +28,16 @@
  * The data model is a subset of XML's; a single-rooted hierarchical tree where each
  * node can contain multiple <em>attributes</em>, and leaf nodes can also
  * contain a <em>value</em>. Reflecting this, <code>Configuration</code>s
are
- * usually built from an XML file by the {@link DefaultConfigurationBuilder}
- * class, or directly by a SAX parser using a {@link SAXConfigurationHandler} or
- * {@link NamespacedSAXConfigurationHandler} event handler.
+ * usually built from an XML file by the DefaultConfigurationBuilder
+ * class, or directly by a SAX parser using a SAXConfigurationHandler or
+ * NamespacedSAXConfigurationHandler event handler.
  * </p>
  * <h4>Namespace support</h4>
  * <p>
  * Since version 4.1, each <code>Configuration</code> node has a namespace
  * associated with it, in the form of a string, accessible through {@link
  * #getNamespace}. If no namespace is present, <code>getNamespace</code> will
- * return blank (""). See {@link DefaultConfigurationBuilder} for details on how
+ * return blank (""). See DefaultConfigurationBuilder for details on how
  * XML namespaces are mapped to <code>Configuration</code> namespaces.
  * </p>
  * <h3>Example</h3>
@@ -51,16 +51,16 @@
  *   &lt;widget name="fooWidget" initOrder="1" threadsafe="true"/&gt;
  * &lt;/my-system&gt;
  * </pre>
- * <p>If namespace support is enabled (eg through {@link
+ * <p>If namespace support is enabled (eg through 
  * DefaultConfigurationBuilder#DefaultConfigurationBuilder(boolean) new
- * DefaultConfigurationBuilder(true)}), then the <code>xmlns:doc</code> element
+ * DefaultConfigurationBuilder(true)), then the <code>xmlns:doc</code> element
  * will not translate into a Configuration attribute, and the
  * <code>doc:desc</code> element will become a <code>Configuration</code>
node
  * with name "desc" and namespace "http://myco.com/documentation". The
  * <code>widget</code> element will have namespace "".
  * </p>
- * <p>If namespace support is disabled (the default for {@link
- * DefaultConfigurationBuilder}), the above XML will translate directly to
+ * <p>If namespace support is disabled (the default for 
+ * DefaultConfigurationBuilder), the above XML will translate directly to
  * <code>Configuration</code> nodes. The <code>my-system</code> node
will have
  * an attribute named "xmlns:doc", and a child called "doc:desc".
  * </p>
@@ -161,7 +161,7 @@
      * Configuration builder. If the Configuration builder does not support
      * namespaces, this method will return a blank string.
      * </p>
-     * <p>In the case of {@link DefaultConfigurationBuilder}, the namespace will
+     * <p>In the case of DefaultConfigurationBuilder, the namespace will
      * be the URI associated with the XML element. Eg.,:</p>
      * <pre>
      * &lt;foo xmlns:x="http://blah.com"&gt;

Modified: avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/Extension.java
==============================================================================
--- avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/Extension.java
(original)
+++ avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/Extension.java
Wed Jun 16 21:38:23 2004
@@ -137,7 +137,7 @@
     /**
      * Enum indicating that extension is incompatible with
      * other extension in ways other than other enums
-     * indicate). ie For example the other extension may have
+     * indicate. For example the other extension may have
      * a different ID.
      */
     public static final Compatability INCOMPATIBLE =

Modified: avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/Specification.java
==============================================================================
--- avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/Specification.java
(original)
+++ avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/Specification.java
Wed Jun 16 21:38:23 2004
@@ -107,7 +107,7 @@
     /**
      * Enum indicating that extension is incompatible with
      * other Package Specification in ways other than other enums
-     * indicate). ie For example the other Package Specification
+     * indicate. For example the other Package Specification
      * may have a different ID.
      */
     public static final Compatability INCOMPATIBLE =

Modified: avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/manager/package.html
==============================================================================
--- avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/manager/package.html
(original)
+++ avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/manager/package.html
Wed Jun 16 21:38:23 2004
@@ -1,4 +1,6 @@
-<body>
-<a name="description"><h3>Description</h3></a>
-<p>Defintion of the the jar file package manager service.</p>
-</body>
+
+<body>
+<p>
+Defintion of the the jar file package manager service.
+</p>
+</body>

Modified: avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/package.html
==============================================================================
--- avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/package.html
(original)
+++ avalon/trunk/runtime/util/extension/api/src/java/org/apache/avalon/extension/package.html
Wed Jun 16 21:38:23 2004
@@ -1,4 +1,6 @@
-<body>
-<a name="description"><h3>Description</h3></a>
-<p>Defintion of the services supporting jar file optional extension management based
on the required and optional extensions declared under a jar file manifest.</p>
-</body>
+
+<body>
+<p>
+Defintion of the services supporting jar file optional extension management based on the
required and optional extensions declared under a jar file manifest.
+</p>
+</body>

Added: avalon/trunk/runtime/util/extension/build.properties
==============================================================================
--- (empty file)
+++ avalon/trunk/runtime/util/extension/build.properties	Wed Jun 16 21:38:23 2004
@@ -0,0 +1,2 @@
+project.home = ../../../central/system
+project.test.compile.fork = true
\ No newline at end of file

Added: avalon/trunk/runtime/util/extension/build.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/runtime/util/extension/build.xml	Wed Jun 16 21:38:23 2004
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<project name="test" default="dist" basedir="." xmlns:x="antlib:org.apache.avalon.tools">
+
+  <property file="build.properties"/>
+  <import file="${project.home}/build/reactor.xml"/>
+
+</project>

Modified: avalon/trunk/runtime/util/extension/impl/src/java/org/apache/avalon/extension/manager/impl/package.html
==============================================================================
--- avalon/trunk/runtime/util/extension/impl/src/java/org/apache/avalon/extension/manager/impl/package.html
(original)
+++ avalon/trunk/runtime/util/extension/impl/src/java/org/apache/avalon/extension/manager/impl/package.html
Wed Jun 16 21:38:23 2004
@@ -1,4 +1,3 @@
 <body>
-<a name="description"><h3>Description</h3></a>
 <p>The extension package is the default implementation of the extension-api specification.
 The package provides support for the management of extension groups and their interation
with the overall management of extension jar files.</p>
 </body>

Modified: avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/tasks/JavadocTask.java
==============================================================================
--- avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/tasks/JavadocTask.java	(original)
+++ avalon/trunk/tools/magic/src/main/org/apache/avalon/tools/tasks/JavadocTask.java	Wed Jun
16 21:38:23 2004
@@ -81,6 +81,7 @@
     public static final String IMPL = "impl";
 
     private String m_root = "";
+    private String m_title;
 
     public void setRoot( String root )
     {
@@ -94,48 +95,44 @@
         }
     }
 
-    public void execute() throws BuildException 
+    public void setTitle( String title )
+    {
+        m_title = title;
+    }
+
+    public void execute() throws BuildException
     {
         Definition def = getHome().getDefinition( getKey() );
         File root = getJavadocRootDirectory( def );
         Path classpath = def.getPath( getProject(), Policy.RUNTIME );
-
-        ArrayList visited = new ArrayList();
-
-        File api = new File( root, "api" );
         Link j2se = new Link( "http://java.sun.com/j2se/1.4/docs/api/" );
         Link[] links = new Link[]{ j2se };
-        setup( def, classpath, visited, ResourceRef.API, api, links, "API", false );
 
+        File api = new File( root, "api" );
         File spi = new File( root, "spi" );
-        //LocalLink apiLink = new LocalLink( "/../api/", api );
-        //links = new Link[]{ j2se, apiLink };
-        setup( def, classpath, visited, ResourceRef.SPI, spi, links, "SPI", false );
-
         File imp = new File( root, "impl" );
-        //LocalLink spiLink = new LocalLink( "/../spi/", spi );
-        //links = new Link[]{ j2se, apiLink, spiLink };
-        setup( def, classpath, visited, ResourceRef.IMPL, imp, links, "IMP", true );
 
+        setup( def, classpath, ResourceRef.API, api, links, "API", false );
+        setup( def, classpath, ResourceRef.SPI, spi, links, "SPI", false );
+        setup( def, classpath, ResourceRef.IMPL, imp, links, "IMPL", true );
     }
 
     private void setup( 
-      Definition def, Path classpath, List visited, int category, File root, 
+      Definition def, Path classpath, int category, File root, 
       Link[] links, String message, boolean flag )
     {
         ResourceRef[] refs = 
           def.getResourceRefs( Policy.RUNTIME, category, true );
-        //ResourceRef[] refs = def.getQualifiedRefs( visited, category );
         if( refs.length > 0 )
         {
             log( "Javadoc " + message + " generation." );
-            generate( def, classpath, refs, root, links, flag );
+            generate( def, classpath, refs, root, links, message, flag );
         }
     }
 
     private void generate( 
        Definition definition, Path classpath, ResourceRef[] refs, 
-       File root, Link[] links, boolean flag )
+       File root, Link[] links, String group, boolean flag )
     {
         Javadoc javadoc = (Javadoc) getProject().createTask( "javadoc" );
 
@@ -143,7 +140,8 @@
         javadoc.setDestdir( root );
         Path source = javadoc.createSourcepath();
         javadoc.createClasspath().add( classpath );
-        
+        javadoc.setDoctitle( getTitle( definition, group ) );
+
         for( int i=0; i<refs.length; i++ )
         {
             ResourceRef ref = refs[i];
@@ -191,6 +189,7 @@
                 source.createPathElement().setLocation( local );
             }
         }
+
         javadoc.execute();
     }
 
@@ -205,6 +204,29 @@
         else
         {
             return new File( docs, version );
+        }
+    }
+
+    private String getTitle( Definition def, String group )
+    {
+        String extra = getTitleSuppliment( def, group );
+        if( null == m_title )
+        {
+            return def.getInfo().getName() + extra;
+        }
+        return m_title + extra;
+    }
+
+    private String getTitleSuppliment( Definition def, String group )
+    {
+        String version = def.getInfo().getVersion();
+        if( null == version )
+        {
+            return " : " + group;
+        }
+        else
+        {
+            return ", Version " + version + " : " + group;
         }
     }
 }

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


Mime
View raw message