adammurdoch 2002/06/11 04:47:04
Modified: buildtools/src/java/org/apache/myrmidon/build
AntlibDescriptorTask.java NameUtil.java
Added: buildtools/src/java/org/apache/myrmidon/build
AntDocRoleSubTask.java AntDocTypeSubTask.java
role.j
Removed: buildtools/src/java/org/apache/myrmidon/build
AntDocSubTask.java
Log:
- Added a subtask to generate documentation for roles.
- Renamed AntDocSubTask to AntDocTypeSubTask.
Revision Changes Path
1.8 +9 -5
jakarta-ant-myrmidon/buildtools/src/java/org/apache/myrmidon/build/AntlibDescriptorTask.java
Index: AntlibDescriptorTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant-myrmidon/buildtools/src/java/org/apache/myrmidon/build/AntlibDescriptorTask.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- AntlibDescriptorTask.java 2 Jun 2002 04:58:51 -0000 1.7
+++ AntlibDescriptorTask.java 11 Jun 2002 11:47:04 -0000 1.8
@@ -45,13 +45,17 @@
}
/**
- * Adds a nested <antdoc> element.
+ * Enables generation of antdoc.
*/
- public void addAntdoc( final AntDocSubTask antDocs )
+ public void setAntdoc( final boolean antDocs )
{
- addTemplate( antDocs );
- final TemplateSubTask typesTemplate = makeTemplateSubTask(
TYPES_TEMPLATE, "types.xml" );
- addTemplate( typesTemplate );
+ if( antDocs )
+ {
+ addTemplate( new AntDocTypeSubTask() );
+ addTemplate( new AntDocRoleSubTask() );
+ final TemplateSubTask typesTemplate = makeTemplateSubTask(
TYPES_TEMPLATE, "types.xml" );
+ addTemplate( typesTemplate );
+ }
}
/**
1.2 +5 -2
jakarta-ant-myrmidon/buildtools/src/java/org/apache/myrmidon/build/NameUtil.java
Index: NameUtil.java
===================================================================
RCS file:
/home/cvs/jakarta-ant-myrmidon/buildtools/src/java/org/apache/myrmidon/build/NameUtil.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NameUtil.java 10 Jun 2002 06:31:06 -0000 1.1
+++ NameUtil.java 11 Jun 2002 11:47:04 -0000 1.2
@@ -67,7 +67,10 @@
final char ch = value.charAt( i );
if( Character.isUpperCase( ch ) )
{
- sb.append( '-' );
+ if( i > 0 )
+ {
+ sb.append( '-' );
+ }
sb.append( Character.toLowerCase( ch ) );
}
else
1.1
jakarta-ant-myrmidon/buildtools/src/java/org/apache/myrmidon/build/AntDocRoleSubTask.java
Index: AntDocRoleSubTask.java
===================================================================
/*
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
* This software is published under the terms of the Apache Software License
* version 1.1, a copy of which has been included with this distribution in
* the LICENSE.txt file.
*/
package org.apache.myrmidon.build;
import xdoclet.TemplateSubTask;
import xdoclet.XDocletException;
import java.net.URL;
import xjavadoc.XClass;
/**
* Generates XML documentation for roles.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Adam Murdoch</a>
* @version $Revision: 1.1 $ $Date: 2002/06/11 11:47:04 $
*/
public class AntDocRoleSubTask
extends AntTypeSubTask
{
public AntDocRoleSubTask()
{
setDestinationFile( "{0}.xml" );
final URL resource = getClass().getResource(
"/org/apache/myrmidon/build/role.j" );
setTemplateURL( resource );
final TemplateSubTask.ExtentTypes extent = new
TemplateSubTask.ExtentTypes();
extent.setValue( "hierarchy" );
setExtent( extent );
}
public String getSubTaskName()
{
return "role-antdoc";
}
protected boolean matchesGenerationRules( final XClass clazz )
throws XDocletException
{
if( !super.matchesGenerationRules( clazz ) )
{
return false;
}
return AntTypeTagHandler.hasRoleTag( clazz );
}
}
1.1
jakarta-ant-myrmidon/buildtools/src/java/org/apache/myrmidon/build/AntDocTypeSubTask.java
Index: AntDocTypeSubTask.java
===================================================================
/*
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
* This software is published under the terms of the Apache Software License
* version 1.1, a copy of which has been included with this distribution in
* the LICENSE.txt file.
*/
package org.apache.myrmidon.build;
import java.net.URL;
import xdoclet.TemplateSubTask;
import xdoclet.XDocletException;
import xjavadoc.XClass;
/**
* Generates the XML Documentation for Ant types (including tasks and
DataTypes).
*
* @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
* @version $Revision: 1.1 $ $Date: 2002/06/11 11:47:04 $
*/
public class AntDocTypeSubTask
extends AntTypeSubTask
{
public AntDocTypeSubTask()
{
setDestinationFile( "{0}.xml" );
final URL resource = getClass().getResource(
"/org/apache/myrmidon/build/type.j" );
setTemplateURL( resource );
final TemplateSubTask.ExtentTypes extent = new
TemplateSubTask.ExtentTypes();
extent.setValue( "hierarchy" );
setExtent( extent );
}
public String getSubTaskName()
{
return "type-antdoc";
}
protected boolean matchesGenerationRules( final XClass clazz )
throws XDocletException
{
if( !super.matchesGenerationRules( clazz ) )
{
return false;
}
return AntTypeTagHandler.hasTypeTag( clazz );
}
}
1.1
jakarta-ant-myrmidon/buildtools/src/java/org/apache/myrmidon/build/role.j
Index: role.j
===================================================================
<role classname="<XDtClass:fullClassName/>" name="<XDtAnt:roleName/>">
<display-name>
<![CDATA[<XDtAnt:roleDisplayName/>]]>
</display-name>
<short-description>
<![CDATA[<XDtClass:firstSentenceDescription/>]]>
</short-description>
<long-description>
<![CDATA[<XDtClass:classComment no-comment-signs="true"/>]]>
</long-description>
</role>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
