Browse Source

fix some javadoc warnings

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@811335 13f79535-47bb-0310-9956-ffa450edef68
master
Stefan Bodewig 16 years ago
parent
commit
996e3e6ff9
10 changed files with 19 additions and 21 deletions
  1. +6
    -8
      src/main/org/apache/tools/ant/property/ParseProperties.java
  2. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/EchoXML.java
  3. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/Jar.java
  4. +2
    -2
      src/main/org/apache/tools/ant/taskdefs/Replace.java
  5. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/condition/Http.java
  6. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/optional/SchemaValidate.java
  7. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.java
  8. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessageBySftp.java
  9. +4
    -4
      src/main/org/apache/tools/ant/types/selectors/SelectorUtils.java
  10. +1
    -1
      src/main/org/apache/tools/ant/types/selectors/TokenizedPattern.java

+ 6
- 8
src/main/org/apache/tools/ant/property/ParseProperties.java View File

@@ -60,10 +60,10 @@ public class ParseProperties implements ParseNextProperty {
* *
* <li>This implementation starts parsing the <code>value</code> * <li>This implementation starts parsing the <code>value</code>
* parameter (unsurprisingly) at the beginning and asks each * parameter (unsurprisingly) at the beginning and asks each
* {@link org.apache.tools.ant.PropertyHelper.PropertyExpander
* PropertyExpander} whether there is a property reference at
* that point. PropertyExpanders return the name of a property
* they may find and may advance the parse position.</li>
* {@link PropertyExpander PropertyExpander} whether there is a
* property reference at that point. PropertyExpanders return
* the name of a property they may find and may advance the parse
* position.</li>
* *
* <li>If the PropertyExpander returns <code>null</code> the * <li>If the PropertyExpander returns <code>null</code> the
* method continues with the next PropertyExpander, otherwise it * method continues with the next PropertyExpander, otherwise it
@@ -121,8 +121,7 @@ public class ParseProperties implements ParseNextProperty {
/** /**
* Learn whether a String contains replaceable properties. * Learn whether a String contains replaceable properties.
* *
* <p>Uses the configured {@link
* org.apache.tools.ant.PropertyHelper.PropertyExpander
* <p>Uses the configured {@link PropertyExpander
* PropertyExpanders} and scans through the string. Returns true * PropertyExpanders} and scans through the string. Returns true
* as soon as any expander finds a property.</p> * as soon as any expander finds a property.</p>
* *
@@ -147,8 +146,7 @@ public class ParseProperties implements ParseNextProperty {
* Return any property that can be parsed from the specified position * Return any property that can be parsed from the specified position
* in the specified String. * in the specified String.
* *
* <p>Uses the configured {@link
* org.apache.tools.ant.PropertyHelper.PropertyExpander
* <p>Uses the configured {@link PropertyExpander
* PropertyExpanders} and {@link GetProperty GetProperty} * PropertyExpanders} and {@link GetProperty GetProperty}
* instance .</p> * instance .</p>
* *


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/EchoXML.java View File

@@ -59,7 +59,7 @@ public class EchoXML extends XMLFragment {


/** /**
* Set the namespace policy for the xml file * Set the namespace policy for the xml file
* @param s namespace policy: "ignore," "elementsOnly," or "all"
* @param n namespace policy: "ignore," "elementsOnly," or "all"
* @see * @see
* org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy * org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy
*/ */


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/Jar.java View File

@@ -678,7 +678,7 @@ public class Jar extends Zip {


/** /**
* Overridden from Zip class to deal with manifests and index lists. * Overridden from Zip class to deal with manifests and index lists.
* @param in the stream to read data for the entry from. The
* @param is the stream to read data for the entry from. The
* caller of the method is responsible for closing the stream. * caller of the method is responsible for closing the stream.
* @param zOut the zip output stream * @param zOut the zip output stream
* @param vPath the name this entry shall have in the archive * @param vPath the name this entry shall have in the archive


+ 2
- 2
src/main/org/apache/tools/ant/taskdefs/Replace.java View File

@@ -201,7 +201,7 @@ public class Replace extends MatchingTask {


/** /**
* Set the token to replace. * Set the token to replace.
* @param token <code>String</code> token.
* @param t <code>String</code> token.
*/ */
public void setToken(String t) { public void setToken(String t) {
createReplaceToken().addText(t); createReplaceToken().addText(t);
@@ -811,7 +811,7 @@ public class Replace extends MatchingTask {
* Sets the name of a resource containing filters; optional. * Sets the name of a resource containing filters; optional.
* Each property will be treated as a replacefilter where token is the name * Each property will be treated as a replacefilter where token is the name
* of the property and value is the value of the property. * of the property and value is the value of the property.
* @param replaceFilterFile <code>File</code> to load.
* @param replaceFilter <code>Resource</code> to load.
* @since Ant 1.8.0 * @since Ant 1.8.0
*/ */
public void setReplaceFilterResource(Resource replaceFilter) { public void setReplaceFilterResource(Resource replaceFilter) {


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/condition/Http.java View File

@@ -70,7 +70,7 @@ public class Http extends ProjectComponent implements Condition {
* such as "GET", "HEAD", "TRACE", etc. The default * such as "GET", "HEAD", "TRACE", etc. The default
* if not specified is "GET". * if not specified is "GET".
* *
* @see java.net.HttpURLConnection.setRequestMethod()
* @see java.net.HttpURLConnection#setRequestMethod()
* @since Ant 1.8.0 * @since Ant 1.8.0
*/ */
public void setRequestMethod(String method) { public void setRequestMethod(String method) {


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/optional/SchemaValidate.java View File

@@ -239,7 +239,7 @@ public class SchemaValidate extends XMLValidateTask {


/** /**
* Create a reader if the use of the class did not specify another one. * Create a reader if the use of the class did not specify another one.
* The reason to not use {@link JAXPUtils#getXMLReader()} was to
* The reason to not use {@link org.apache.tools.ant.util.JAXPUtils#getXMLReader()} was to
* create our own factory with our own options. * create our own factory with our own options.
* @return a default XML parser * @return a default XML parser
*/ */


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.java View File

@@ -103,7 +103,7 @@ public class ScpFromMessage extends AbstractSshMessage {
* @param aRemoteFile the remote file name * @param aRemoteFile the remote file name
* @param aLocalFile the local file * @param aLocalFile the local file
* @param recursive if true use recursion (-r option to scp) * @param recursive if true use recursion (-r option to scp)
* @param preservceLastModified whether to preserve file
* @param preserveLastModified whether to preserve file
* modification times * modification times
* @since Ant 1.8.0 * @since Ant 1.8.0
*/ */


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessageBySftp.java View File

@@ -80,7 +80,7 @@ public class ScpFromMessageBySftp extends ScpFromMessage {
* @param aRemoteFile the remote file name * @param aRemoteFile the remote file name
* @param aLocalFile the local file * @param aLocalFile the local file
* @param recursive if true use recursion * @param recursive if true use recursion
* @param preservceLastModified whether to preserve file
* @param preserveLastModified whether to preserve file
* modification times * modification times
* @since Ant 1.8.0 * @since Ant 1.8.0
*/ */


+ 4
- 4
src/main/org/apache/tools/ant/types/selectors/SelectorUtils.java View File

@@ -173,9 +173,9 @@ public final class SelectorUtils {
* Tests whether or not a given path matches a given pattern. * Tests whether or not a given path matches a given pattern.
* *
* If you need to call this method multiple times with the same * If you need to call this method multiple times with the same
* pattern you should rather use PathPattern
* pattern you should rather use TokenizedPath
* *
* @see PathPattern
* @see TokenizedPath
* *
* @param pattern The pattern to match against. Must not be * @param pattern The pattern to match against. Must not be
* <code>null</code>. * <code>null</code>.
@@ -194,9 +194,9 @@ public final class SelectorUtils {
* Tests whether or not a given path matches a given pattern. * Tests whether or not a given path matches a given pattern.
* *
* If you need to call this method multiple times with the same * If you need to call this method multiple times with the same
* pattern you should rather use PathPattern
* pattern you should rather use TokenizedPattern
* *
* @see PathPattern
* @see TokenizedPattern
* *
* @param pattern The pattern to match against. Must not be * @param pattern The pattern to match against. Must not be
* <code>null</code>. * <code>null</code>.


+ 1
- 1
src/main/org/apache/tools/ant/types/selectors/TokenizedPattern.java View File

@@ -57,7 +57,7 @@ public class TokenizedPattern {
/** /**
* Tests whether or not a given path matches a given pattern. * Tests whether or not a given path matches a given pattern.
* *
* @param str The path to match, as a String. Must not be
* @param path The path to match, as a String. Must not be
* <code>null</code>. * <code>null</code>.
* @param isCaseSensitive Whether or not matching should be performed * @param isCaseSensitive Whether or not matching should be performed
* case sensitively. * case sensitively.


Loading…
Cancel
Save