mcconnell 2003/07/15 13:03:05
Modified: meta maven.xml
meta/impl/src/java/org/apache/avalon/meta/info/writer
XMLTypeWriter.java
meta/site/xdocs navigation.xml
meta/site/xdocs/meta navigation.xml
meta/site/xdocs/meta/info navigation.xml
meta/site/xdocs/meta/info/attributes navigation.xml
meta/site/xdocs/meta/info/type navigation.xml
meta/site/xdocs/meta/info/type/context navigation.xml
meta/site/xdocs/meta/info/type/dependencies navigation.xml
meta/site/xdocs/meta/info/type/extensions navigation.xml
meta/site/xdocs/meta/info/type/loggers navigation.xml
meta/site/xdocs/meta/info/type/services navigation.xml
meta/site/xdocs/meta/info/type/stages navigation.xml
meta/site/xdocs/tools navigation.xml
meta/site/xdocs/tools/maven navigation.xml
meta/site/xdocs/tools/tags navigation.xml
meta/site/xdocs/tutorial navigation.xml
meta/tools/src/java/org/apache/avalon/meta/info/ant
MetaTask.java
meta/tools/src/java/org/apache/avalon/meta/info/builder/tags
TypeTag.java
Log:
Javadoc updating and housekeeping.
Revision Changes Path
1.4 +1 -1 avalon-sandbox/meta/maven.xml
Index: maven.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/maven.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- maven.xml 14 Jul 2003 20:14:22 -0000 1.3
+++ maven.xml 15 Jul 2003 20:03:03 -0000 1.4
@@ -59,7 +59,7 @@
noindex="false" author="true" use="true"
windowtitle="${title}"
bottom="${copyright}"
- additionalparam="-breakiterator -J-Xmx128m -tag todo:a:ToDo: "
+ additionalparam="-breakiterator -J-Xmx128m "
packagenames="*,org.*">
<j:forEach var="packageGroup" items="${pom.packageGroups}">
<group title="${packageGroup.title}"
packages="${packageGroup.packages}"/>
1.7 +2 -2
avalon-sandbox/meta/impl/src/java/org/apache/avalon/meta/info/writer/XMLTypeWriter.java
Index: XMLTypeWriter.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/meta/impl/src/java/org/apache/avalon/meta/info/writer/XMLTypeWriter.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- XMLTypeWriter.java 15 Jul 2003 19:15:57 -0000 1.6
+++ XMLTypeWriter.java 15 Jul 2003 20:03:03 -0000 1.7
@@ -68,7 +68,7 @@
/**
* Write [EMAIL PROTECTED] Type} objects to a stream as xml documents.
*
- * @todo Address configuration schema support
+ * TODO: Address configuration schema support
* @author <a href="mailto:[EMAIL PROTECTED]">Avalon Development Team</a>
* @version $Revision$ $Date$
*/
1.2 +1 -0 avalon-sandbox/meta/site/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:18 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:03 -0000 1.2
@@ -18,6 +18,7 @@
<item name="Getting Started" href="/tutorial/index.html"/>
<item name="Meta Model" href="/meta/index.html"/>
<item name="Tools" href="/tools/index.html"/>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0 avalon-sandbox/meta/site/xdocs/meta/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:18 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:03 -0000 1.2
@@ -20,6 +20,7 @@
<item name="Directives"
href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
</item>
<item name="Tools" href="/tools/index.html"/>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0 avalon-sandbox/meta/site/xdocs/meta/info/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:18 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
@@ -25,6 +25,7 @@
<item name="Directives"
href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
</item>
<item name="Tools" href="/tools/index.html"/>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0
avalon-sandbox/meta/site/xdocs/meta/info/attributes/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/attributes/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:18 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
@@ -27,6 +27,7 @@
<item name="Directives"
href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
</item>
<item name="Tools" href="/tools/index.html"/>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0 avalon-sandbox/meta/site/xdocs/meta/info/type/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:18 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
@@ -33,6 +33,7 @@
<item name="Directives"
href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
</item>
<item name="Tools" href="/tools/index.html"/>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0
avalon-sandbox/meta/site/xdocs/meta/info/type/context/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/context/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:18 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
@@ -35,6 +35,7 @@
<item name="Directives"
href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
</item>
<item name="Tools" href="/tools/index.html"/>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0
avalon-sandbox/meta/site/xdocs/meta/info/type/dependencies/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/dependencies/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:18 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
@@ -35,6 +35,7 @@
<item name="Directives"
href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
</item>
<item name="Tools" href="/tools/index.html"/>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0
avalon-sandbox/meta/site/xdocs/meta/info/type/extensions/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/extensions/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:19 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
@@ -35,6 +35,7 @@
<item name="Directives"
href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
</item>
<item name="Tools" href="/tools/index.html"/>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0
avalon-sandbox/meta/site/xdocs/meta/info/type/loggers/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/loggers/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:19 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
@@ -35,6 +35,7 @@
<item name="Directives"
href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
</item>
<item name="Tools" href="/tools/index.html"/>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0
avalon-sandbox/meta/site/xdocs/meta/info/type/services/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/services/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:19 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
@@ -35,6 +35,7 @@
<item name="Directives"
href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
</item>
<item name="Tools" href="/tools/index.html"/>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0
avalon-sandbox/meta/site/xdocs/meta/info/type/stages/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon-sandbox/meta/site/xdocs/meta/info/type/stages/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:19 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:04 -0000 1.2
@@ -35,6 +35,7 @@
<item name="Directives"
href="http://avalon.apache.org/sandbox/merlin/meta/model"/>
</item>
<item name="Tools" href="/tools/index.html"/>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0 avalon-sandbox/meta/site/xdocs/tools/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/tools/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:19 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:05 -0000 1.2
@@ -22,6 +22,7 @@
<item name="Meta-Info Generator Task" href="/tools/ant.html"/>
<item name="Avalon Plugin for Maven" href="/tools/maven/index.html"/>
</item>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0 avalon-sandbox/meta/site/xdocs/tools/maven/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/tools/maven/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:19 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:05 -0000 1.2
@@ -24,6 +24,7 @@
<item name="Meta Generation" href="/tools/maven/meta.html"/>
</item>
</item>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0 avalon-sandbox/meta/site/xdocs/tools/tags/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/tools/tags/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:21 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:05 -0000 1.2
@@ -34,6 +34,7 @@
<item name="Meta-Info Generator Task" href="/tools/ant.html"/>
<item name="Avalon Plugin for Maven" href="/tools/maven/index.html"/>
</item>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.2 +1 -0 avalon-sandbox/meta/site/xdocs/tutorial/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/meta/site/xdocs/tutorial/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 14 Jul 2003 20:22:22 -0000 1.1
+++ navigation.xml 15 Jul 2003 20:03:05 -0000 1.2
@@ -18,6 +18,7 @@
<item name="Getting Started" href="/tutorial/index.html"/>
<item name="Meta Model" href="/meta/index.html"/>
<item name="Tools" href="/tools/index.html"/>
+ <item name="Javadoc" href="/api/index.html"/>
</menu>
</body>
1.3 +1 -5
avalon-sandbox/meta/tools/src/java/org/apache/avalon/meta/info/ant/MetaTask.java
Index: MetaTask.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/meta/tools/src/java/org/apache/avalon/meta/info/ant/MetaTask.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- MetaTask.java 14 Jul 2003 20:14:24 -0000 1.2
+++ MetaTask.java 15 Jul 2003 20:03:05 -0000 1.3
@@ -288,8 +288,6 @@
// a service descriptor
//
- //final TaggedServiceBuilder builder = new TaggedServiceBuilder();
- //Service info = builder.buildService( javaClass );
final String classname = javaClass.getFullyQualifiedName();
final File source = javaClass.getParentSource().getFile();
final File dest = getOutputFileForService( classname );
@@ -329,8 +327,6 @@
// a type descriptor
//
- //final TaggedTypeBuilder infoBuilder = new TaggedTypeBuilder();
- //Type info = infoBuilder.buildType( javaClass );
final String classname = javaClass.getFullyQualifiedName();
final File source = javaClass.getParentSource().getFile();
final File dest = getOutputFileForClass( classname );
1.2 +35 -5
avalon-sandbox/meta/tools/src/java/org/apache/avalon/meta/info/builder/tags/TypeTag.java
Index: TypeTag.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/meta/tools/src/java/org/apache/avalon/meta/info/builder/tags/TypeTag.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TypeTag.java 14 Jul 2003 20:14:24 -0000 1.1
+++ TypeTag.java 15 Jul 2003 20:03:05 -0000 1.2
@@ -65,7 +65,28 @@
import com.thoughtworks.qdox.model.JavaClass;
/**
- * A doclet tag the declares a component type.
+ * <p>A doclet tag the declares a a [EMAIL PROTECTED] Type} descriptor using the
+ * <code>&avalon.type</code> or <code>&avalon.component</code>
+ * javadoc tag. The &avalon.component is senonomouse with &avalon.type.
+ * The &avalon.type tag recognizes the following attributes:<p>
+ *
+ * <table border="1" cellpadding="3" cellspacing="0" width="100%">
+ * <tr bgcolor="#CCCCFF" class="TableHeadingColor">
+ * <td colspan="3"><p><b>Tag Attributes</b></p></td>
+ * </tr>
+ * <tr bgcolor="white" class="TableRowColor">
+ * <td>name</td><td>required</td>
+ * <td>The name of the component type.</td></tr>
+ * <tr bgcolor="white" class="TableRowColor">
+ * <td>version</td><td>optional</td>
+ * <td>A version identifier in the format [major].[minor].[micro].
+ * If not supplied the version 1.0.0 will be assumed.</td></tr>
+ * <tr bgcolor="white" class="TableRowColor">
+ * <td>lifestyle</td><td>optional</td>
+ * <td>The component implementation lifestyle - one of "singleton",
+ * "thread", "pooled", or "transient". If not supplied "transient"
+ * is assumed.</td></tr>
+ * </table>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Avalon Development Team</a>
* @version $Revision$ $Date$
@@ -73,11 +94,16 @@
public class TypeTag extends AbstractTag
{
/**
- * Javadoc tag key for the name tag.
+ * Javadoc tag key for the type tag.
*/
public static final String KEY = "type";
/**
+ * Alternative tag name.
+ */
+ public static final String COMPONENT_KEY = "component";
+
+ /**
* The name parameter
*/
public static final String NAME_PARAM = "name";
@@ -108,10 +134,14 @@
*/
public Type getType()
{
- final DocletTag tag = getJavaClass().getTagByName( getNS() + Tags.DELIMITER
+ KEY );
+ DocletTag tag = getJavaClass().getTagByName( getNS() + Tags.DELIMITER + KEY
);
if( null == tag )
{
- return null;
+ tag = getJavaClass().getTagByName( getNS() + Tags.DELIMITER +
COMPONENT_KEY );
+ if( null == tag )
+ {
+ return null;
+ }
}
final String name = getNamedParameter( tag, NAME_PARAM );
final Version version = Version.getVersion( getNamedParameter( tag,
VERSION_PARAM, "" ) );
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
