Commits

Jesse N. Glick  committed 3c82c83

#43362 follow-ups: missing/incorrect @since; minor doc improvements and corrections.

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@148476713f79535-47bb-0310-9956-ffa450edef68

  • Participants
  • Parent commits eab7204

Comments (0)

Files changed (12)

 
  * simplifying Execute.getEnvironmentVariables since we are only running on Java 1.5 or higher now
 
- * Add conditional attributes
-   Bugzilla report 43362
+ * Added conditional attributes.
+   Bugzilla Report 43362
 
  * Recommending to upgrade jsch to 0.1.50, particularly if you are using Java 1.7.
    jsch is the library behind the sshexec and scp Ant tasks.

File manual/Types/namespace.html

       </li>
     </ul>
     <p>
-      In Ant 1.9.1 two attribute namespaces ant:if and ant:unless are added in order to allow to insert elements
-      conditionally
+      In Ant 1.9.1 two attribute namespaces <code>ant:if</code> and <code>ant:unless</code> were added
+      to allow you to insert elements conditionally.
     </p>
     <p>
       Other attributes are simply ignored.

File src/main/org/apache/tools/ant/DefaultDefinitions.java

 
 /**
  * Default definitions.
+ * @since Ant 1.9.1
  */
 public final class DefaultDefinitions {
     private static final String IF_NAMESPACE = "ant:if";
     }
 
     /**
-     * Register the defintions.
+     * Register the definitions.
      */
     public void execute() {
         attributeNamespaceDef(IF_NAMESPACE);

File src/main/org/apache/tools/ant/MagicNames.java

      * @since Ant 1.9.0
      */
     public static final String ANT_VM_LAUNCHER_REF_ID = "ant.vmLauncher";
-    /** Name of the namespace "type" (note: cannot be used as an element)
-     *  @since  Ant 1.9.1
-     * */
+    /**
+     * Name of the namespace "type".
+     * (Note: cannot be used as an element.)
+     * @since Ant 1.9.1
+     */
     public static final String ATTRIBUTE_NAMESPACE = "attribute namespace";
 }
 

File src/main/org/apache/tools/ant/RuntimeConfigurable.java

      * @param owner the UE that owns this RC.
      * @return true if enabled, false if any of the ant attribures return
      *              false.
+     * @since 1.9.1
      */
     public boolean isEnabled(UnknownElement owner) {
         if (!namespacedAttribute) {

File src/main/org/apache/tools/ant/attribute/AttributeNamespace.java

 package org.apache.tools.ant.attribute;
 
 /**
- * This class is used to indicate that the xml namespace (uri)
+ * This class is used to indicate that the XML namespace (URI)
  * can be used to look for namespace attributes.
+ * @see org.apache.tools.ant.taskdefs.AttributeNamespaceDef
+ * @since Ant 1.9.1
  */
 public final class AttributeNamespace {
 }

File src/main/org/apache/tools/ant/attribute/BaseIfAttribute.java

  * An abstract class for if/unless attributes.
  * This contains a boolean flag to specify whether this is an
  * if or unless attribute.
+ * @since Ant 1.9.1
  */
 public abstract class BaseIfAttribute
     extends ProjectComponent implements EnableAttribute {

File src/main/org/apache/tools/ant/attribute/EnableAttribute.java

 import org.apache.tools.ant.UnknownElement;
 
 /**
- * This interface is used by ant attributes.
+ * This interface is used by Ant attributes.
+ * @since Ant 1.9.1
  */
 public interface EnableAttribute {
     /**

File src/main/org/apache/tools/ant/attribute/IfBlankAttribute.java

 
 /**
  * Check if an attribute is blank or not.
+ * @since Ant 1.9.1
  */
 public class IfBlankAttribute extends BaseIfAttribute {
     /** The unless version */

File src/main/org/apache/tools/ant/attribute/IfSetAttribute.java

 
 /**
  * Check if an attribute value as a property is set or not
+ * @since Ant 1.9.1
  */
 public class IfSetAttribute extends BaseIfAttribute {
     /** The unless version */

File src/main/org/apache/tools/ant/attribute/IfTrueAttribute.java

 
 /**
  * Check if an attribute value is true or not.
+ * @since Ant 1.9.1
  */
 public class IfTrueAttribute extends BaseIfAttribute {
     /** The unless version */

File src/main/org/apache/tools/ant/taskdefs/AttributeNamespaceDef.java

 import org.apache.tools.ant.attribute.AttributeNamespace;
 
 /**
- * Defintion to allow the uri to be considered for
- * ant attributes.
+ * Definition to allow the URI to be considered for
+ * Ant attributes.
  *
- * @since Ant 1.8.0
+ * @since Ant 1.9.1
  */
 public final class AttributeNamespaceDef  extends AntlibDefinition {
 
     /**
      * Run the definition.
-     * This registers the xml namespace (uri) as a namepace for
+     * This registers the XML namespace (URI) as a namepace for
      * attributes.
      */
     public void execute() {