peterreilly 2005/03/11 02:01:22
Modified: src/main/org/apache/tools/ant/types Assertions.java
Log:
javadoc
Revision Changes Path
1.18 +13 -10 ant/src/main/org/apache/tools/ant/types/Assertions.java
Index: Assertions.java
===================================================================
RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/types/Assertions.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- Assertions.java 22 Nov 2004 09:23:36 -0000 1.17
+++ Assertions.java 11 Mar 2005 10:01:22 -0000 1.18
@@ -1,5 +1,5 @@
/*
- * Copyright 2000-2004 The Apache Software Foundation
+ * Copyright 2000-2005 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -80,7 +80,7 @@
/**
* enable assertions
- * @param assertion
+ * @param assertion an enable assertion nested element
*/
public void addEnable(EnabledAssertion assertion) {
checkChildrenAllowed();
@@ -89,7 +89,7 @@
/**
* disable assertions
- * @param assertion
+ * @param assertion a disable assertion nested element
*/
public void addDisable(DisabledAssertion assertion) {
checkChildrenAllowed();
@@ -97,8 +97,10 @@
}
/**
- * enable or disable system assertions
- * @param enableSystemAssertions
+ * enable or disable system assertions.
+ * Default is not set (neither -enablesystemassersions or
-disablesytemassertions
+ * are used on the command line).
+ * @param enableSystemAssertions if true enable system assertions
*/
public void setEnableSystemAssertions(Boolean enableSystemAssertions) {
checkAttributesAllowed();
@@ -112,6 +114,7 @@
* have been set as well or child elements have been created and
* thus override this method. if they do the must call
* <code>super.setRefid</code>.</p>
+ * @param ref the reference to use
*/
public void setRefid(Reference ref) {
if (assertionList.size() > 0 || enableSystemAssertions != null) {
@@ -157,7 +160,7 @@
/**
* add the assertions to a list in a format suitable
* for adding to a command line
- * @param commandList
+ * @param commandList the command line to format
*/
public void applyAssertions(List commandList) {
getProject().log("Applying assertions", Project.MSG_DEBUG);
@@ -183,7 +186,7 @@
/**
* apply all the assertions to the command.
- * @param command
+ * @param command the command line to format
*/
public void applyAssertions(CommandlineJava command) {
Assertions clause = getFinalReference();
@@ -246,7 +249,7 @@
* This is not a full depth clone; the list of assertions is cloned,
* but it does not clone the underlying assertions.
* @return a cli
- * @throws CloneNotSupportedException
+ * @throws CloneNotSupportedException if the super class does not
support cloning
*/
public Object clone() throws CloneNotSupportedException {
Assertions that = (Assertions) super.clone();
@@ -264,7 +267,7 @@
/**
* name a class
- * @param className
+ * @param className a class name
*/
public void setClass(String className) {
this.className = className;
@@ -272,7 +275,7 @@
/**
* name a package
- * @param packageName
+ * @param packageName a package name
*/
public void setPackage(String packageName) {
this.packageName = packageName;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
