Browse Source

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

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@1484767 13f79535-47bb-0310-9956-ffa450edef68
master
Jesse N. Glick 12 years ago
parent
commit
ba19f6fab9
12 changed files with 25 additions and 14 deletions
  1. +2
    -2
      WHATSNEW
  2. +2
    -2
      manual/Types/namespace.html
  3. +2
    -1
      src/main/org/apache/tools/ant/DefaultDefinitions.java
  4. +5
    -3
      src/main/org/apache/tools/ant/MagicNames.java
  5. +1
    -0
      src/main/org/apache/tools/ant/RuntimeConfigurable.java
  6. +3
    -1
      src/main/org/apache/tools/ant/attribute/AttributeNamespace.java
  7. +1
    -0
      src/main/org/apache/tools/ant/attribute/BaseIfAttribute.java
  8. +2
    -1
      src/main/org/apache/tools/ant/attribute/EnableAttribute.java
  9. +1
    -0
      src/main/org/apache/tools/ant/attribute/IfBlankAttribute.java
  10. +1
    -0
      src/main/org/apache/tools/ant/attribute/IfSetAttribute.java
  11. +1
    -0
      src/main/org/apache/tools/ant/attribute/IfTrueAttribute.java
  12. +4
    -4
      src/main/org/apache/tools/ant/taskdefs/AttributeNamespaceDef.java

+ 2
- 2
WHATSNEW View File

@@ -51,8 +51,8 @@ Other changes:


* simplifying Execute.getEnvironmentVariables since we are only running on Java 1.5 or higher now * 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. * 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. jsch is the library behind the sshexec and scp Ant tasks.


+ 2
- 2
manual/Types/namespace.html View File

@@ -152,8 +152,8 @@
</li> </li>
</ul> </ul>
<p> <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>
<p> <p>
Other attributes are simply ignored. Other attributes are simply ignored.


+ 2
- 1
src/main/org/apache/tools/ant/DefaultDefinitions.java View File

@@ -20,6 +20,7 @@ package org.apache.tools.ant;


/** /**
* Default definitions. * Default definitions.
* @since Ant 1.9.1
*/ */
public final class DefaultDefinitions { public final class DefaultDefinitions {
private static final String IF_NAMESPACE = "ant:if"; private static final String IF_NAMESPACE = "ant:if";
@@ -37,7 +38,7 @@ public final class DefaultDefinitions {
} }


/** /**
* Register the defintions.
* Register the definitions.
*/ */
public void execute() { public void execute() {
attributeNamespaceDef(IF_NAMESPACE); attributeNamespaceDef(IF_NAMESPACE);


+ 5
- 3
src/main/org/apache/tools/ant/MagicNames.java View File

@@ -276,9 +276,11 @@ public final class MagicNames {
* @since Ant 1.9.0 * @since Ant 1.9.0
*/ */
public static final String ANT_VM_LAUNCHER_REF_ID = "ant.vmLauncher"; 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"; public static final String ATTRIBUTE_NAMESPACE = "attribute namespace";
} }



+ 1
- 0
src/main/org/apache/tools/ant/RuntimeConfigurable.java View File

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


+ 3
- 1
src/main/org/apache/tools/ant/attribute/AttributeNamespace.java View File

@@ -19,8 +19,10 @@
package org.apache.tools.ant.attribute; 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. * can be used to look for namespace attributes.
* @see org.apache.tools.ant.taskdefs.AttributeNamespaceDef
* @since Ant 1.9.1
*/ */
public final class AttributeNamespace { public final class AttributeNamespace {
} }

+ 1
- 0
src/main/org/apache/tools/ant/attribute/BaseIfAttribute.java View File

@@ -31,6 +31,7 @@ import org.apache.tools.ant.UnknownElement;
* An abstract class for if/unless attributes. * An abstract class for if/unless attributes.
* This contains a boolean flag to specify whether this is an * This contains a boolean flag to specify whether this is an
* if or unless attribute. * if or unless attribute.
* @since Ant 1.9.1
*/ */
public abstract class BaseIfAttribute public abstract class BaseIfAttribute
extends ProjectComponent implements EnableAttribute { extends ProjectComponent implements EnableAttribute {


+ 2
- 1
src/main/org/apache/tools/ant/attribute/EnableAttribute.java View File

@@ -21,7 +21,8 @@ package org.apache.tools.ant.attribute;
import org.apache.tools.ant.UnknownElement; 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 { public interface EnableAttribute {
/** /**


+ 1
- 0
src/main/org/apache/tools/ant/attribute/IfBlankAttribute.java View File

@@ -22,6 +22,7 @@ import org.apache.tools.ant.UnknownElement;


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


+ 1
- 0
src/main/org/apache/tools/ant/attribute/IfSetAttribute.java View File

@@ -22,6 +22,7 @@ import org.apache.tools.ant.UnknownElement;


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


+ 1
- 0
src/main/org/apache/tools/ant/attribute/IfTrueAttribute.java View File

@@ -23,6 +23,7 @@ import org.apache.tools.ant.UnknownElement;


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


+ 4
- 4
src/main/org/apache/tools/ant/taskdefs/AttributeNamespaceDef.java View File

@@ -24,16 +24,16 @@ import org.apache.tools.ant.AntTypeDefinition;
import org.apache.tools.ant.attribute.AttributeNamespace; 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 { public final class AttributeNamespaceDef extends AntlibDefinition {


/** /**
* Run the definition. * Run the definition.
* This registers the xml namespace (uri) as a namepace for
* This registers the XML namespace (URI) as a namepace for
* attributes. * attributes.
*/ */
public void execute() { public void execute() {


Loading…
Cancel
Save