You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ant.apache.org by pe...@apache.org on 2004/01/08 18:34:57 UTC
cvs commit: ant/docs/manual/CoreTasks macrodef.html
peterreilly 2004/01/08 09:34:57
Modified: src/main/org/apache/tools/ant/taskdefs MacroDef.java
docs/manual/CoreTasks macrodef.html
Log:
Add description attributes for elements and attributes of macrodef
PR: 24711
Obtained from: gudnabrsam at yahoo dot com and Yuji Yamano
Revision Changes Path
1.16 +33 -0 ant/src/main/org/apache/tools/ant/taskdefs/MacroDef.java
Index: MacroDef.java
===================================================================
RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/MacroDef.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- MacroDef.java 22 Dec 2003 09:46:23 -0000 1.15
+++ MacroDef.java 8 Jan 2004 17:34:57 -0000 1.16
@@ -283,6 +283,7 @@
public static class Attribute {
private String name;
private String defaultValue;
+ private String description;
/**
* The name of the attribute.
@@ -322,6 +323,21 @@
}
/**
+ * @param desc Description of the element.
+ */
+ public void setDescription(String desc) {
+ description = desc;
+ }
+
+ /**
+ * @return the description of the element, or <code>null</code> if
+ * no description is available.
+ */
+ public String getDescription() {
+ return description;
+ }
+
+ /**
* equality method
*
* @param obj an <code>Object</code> value
@@ -367,6 +383,8 @@
public static class TemplateElement {
private String name;
private boolean optional = false;
+ private String description;
+
/**
* The name of the element.
*
@@ -402,6 +420,21 @@
*/
public boolean isOptional() {
return optional;
+ }
+
+ /**
+ * @param desc Description of the element.
+ */
+ public void setDescription(String desc) {
+ description = desc;
+ }
+
+ /**
+ * @return the description of the element, or <code>null</code> if
+ * no description is available.
+ */
+ public String getDescription() {
+ return description;
}
/**
1.8 +15 -0 ant/docs/manual/CoreTasks/macrodef.html
Index: macrodef.html
===================================================================
RCS file: /home/cvs/ant/docs/manual/CoreTasks/macrodef.html,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- macrodef.html 22 Dec 2003 09:46:23 -0000 1.7
+++ macrodef.html 8 Jan 2004 17:34:57 -0000 1.8
@@ -84,6 +84,13 @@
</td>
<td valign="top" align="center">No</td>
</tr>
+ <tr>
+ <td valign="top">description</td>
+ <td valign="top">
+ This contains a description of the attribute.
+ </td>
+ <td valign="top" align="center">No</td>
+ </tr>
</table>
<h4>element</h4>
<p>
@@ -109,6 +116,14 @@
If true this nested element is optional. Default is
false - i.e the nested element is required in
the new task.
+ </td>
+ <td valign="top" align="center">No</td>
+ </tr>
+ <tr>
+ <td valign="top">description</td>
+ <td valign="top">
+ This contains a description
+ informing the user what the contents of the element are expected to be.
</td>
<td valign="top" align="center">No</td>
</tr>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org