Javadoc fixes for RuntimeConfigurable, Project, Location

PR: 30160
Submitted by: Jesse Glick (jglick at netbeans dot org)


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

WHATSNEW

@@ -39,6 +39,9 @@ Other changes:
 
 * New attribute ignorecontents for <different> selector
 
+* Javadoc fixes for Location, Project, and RuntimeConfigurable
+  Bugzilla 30160.
+
 Fixed bugs:
 -----------
 

src/main/org/apache/tools/ant/Location.java

@@ -113,7 +113,7 @@ public class Location implements Serializable {
      * An error message can be appended easily. For unknown locations, an
      * empty string is returned.
      *
-     * @return a String of the form <code>"fileName: lineNumber: "</code>
+     * @return a String of the form <code>"fileName:lineNumber: "</code>
      *         if both file name and line number are known,
      *         <code>"fileName: "</code> if only the file name is known,
      *         and the empty string for unknown locations.

src/main/org/apache/tools/ant/Project.java

@@ -88,31 +88,31 @@ public class Project {
     /**
      * Version constant for Java 1.0
      *
-     * @deprecated use org.apache.tools.ant.util.JavaEnvUtils instead
+     * @deprecated Use {@link JavaEnvUtils#JAVA_1_0} instead.
      */
     public static final String JAVA_1_0 = JavaEnvUtils.JAVA_1_0;
     /**
      * Version constant for Java 1.1
      *
-     * @deprecated use org.apache.tools.ant.util.JavaEnvUtils instead
+     * @deprecated Use {@link JavaEnvUtils#JAVA_1_1} instead.
      */
     public static final String JAVA_1_1 = JavaEnvUtils.JAVA_1_1;
     /**
      * Version constant for Java 1.2
      *
-     * @deprecated use org.apache.tools.ant.util.JavaEnvUtils instead
+     * @deprecated Use {@link JavaEnvUtils#JAVA_1_2} instead.
      */
     public static final String JAVA_1_2 = JavaEnvUtils.JAVA_1_2;
     /**
      * Version constant for Java 1.3
      *
-     * @deprecated use org.apache.tools.ant.util.JavaEnvUtils instead
+     * @deprecated Use {@link JavaEnvUtils#JAVA_1_3} instead.
      */
     public static final String JAVA_1_3 = JavaEnvUtils.JAVA_1_3;
     /**
      * Version constant for Java 1.4
      *
-     * @deprecated use org.apache.tools.ant.util.JavaEnvUtils instead
+     * @deprecated Use {@link JavaEnvUtils#JAVA_1_4} instead.
      */
     public static final String JAVA_1_4 = JavaEnvUtils.JAVA_1_4;
 

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

@@ -180,6 +180,7 @@ public class RuntimeConfigurable implements Serializable {
     /** Return the attribute map.
      *
      * @return Attribute name to attribute value map
+     * @since Ant 1.6
      */
     public Hashtable getAttributeMap() {
         if (attributeMap != null) {
@@ -192,7 +193,7 @@ public class RuntimeConfigurable implements Serializable {
     /**
      * Returns the list of attributes for the wrapped element.
      *
-     * @deprecated
+     * @deprecated Deprecated since Ant 1.6 in favor of {@link #getAttributeMap}.
      * @return An AttributeList representing the attributes defined in the
      *         XML for this element. May be <code>null</code>.
      */
@@ -228,7 +229,7 @@ public class RuntimeConfigurable implements Serializable {
     /**
      * Returns an enumeration of all child wrappers.
      * @return an enumeration of the child wrappers.
-     * @since Ant 1.5.1
+     * @since Ant 1.6
      */
     public Enumeration getChildren() {
         if (children != null) {
@@ -279,6 +280,7 @@ public class RuntimeConfigurable implements Serializable {
      * multiple fragments.
      *
      * @return the text content of this element.
+     * @since Ant 1.6
      */
     public StringBuffer getText() {
         if (characters != null) {