Javadoc

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

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

@@ -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.
@@ -178,7 +178,7 @@ public abstract class Task extends ProjectComponent {
      * if target1 and target2 both depend on target3, then running
      * "ant target1 target2" will run all tasks in target3 twice.
      *
-     * @exception BuildException if something goes wrong with the build
+     * @exception BuildException if something goes wrong with the build.
      */
     public void execute() throws BuildException {
     }
@@ -200,7 +200,7 @@ public abstract class Task extends ProjectComponent {
      * Sets the file/location where this task was defined.
      *
      * @param location The file/location where this task was defined.
-     *                 Should not be <code>null</code> - use
+     *                 Should not be <code>null</code>--use
      *                 Location.UNKNOWN_LOCATION if the location isn't known.
      *
      * @see Location#UNKNOWN_LOCATION
@@ -226,7 +226,7 @@ public abstract class Task extends ProjectComponent {
     /**
      * Sets the wrapper to be used for runtime configuration.
      *
-     * This method should be used only by the ProjectHelper and ant internals.
+     * This method should be used only by the ProjectHelper and Ant internals.
      * It is public to allow helper plugins to operate on tasks, normal tasks
      * should never use it.
      *
@@ -261,8 +261,7 @@ public abstract class Task extends ProjectComponent {
     }
 
     /**
-     * Force the task to be reconfigured from it's RuntimeConfigurable
-     *
+     * Force the task to be reconfigured from its RuntimeConfigurable.
      */
     public void reconfigure() {
         if (wrapper != null) {
@@ -291,15 +290,15 @@ public abstract class Task extends ProjectComponent {
     }
 
     /**
-     * Handle an input request by this task
+     * Handle an input request by this task.
      *
      * @param buffer the buffer into which data is to be read.
      * @param offset the offset into the buffer at which data is stored.
-     * @param length the amount of data to read
+     * @param length the amount of data to read.
      *
-     * @return the number of bytes read
+     * @return the number of bytes read.
      *
-     * @exception IOException if the data cannot be read
+     * @exception IOException if the data cannot be read.
      * @since Ant 1.6
      */
     protected int handleInput(byte[] buffer, int offset, int length)
@@ -460,18 +459,18 @@ public abstract class Task extends ProjectComponent {
     }
 
     /**
-     * Return the type of task
+     * Return the type of task.
      *
-     * @return the type of task
+     * @return the type of task.
      */
     public String getTaskType() {
         return taskType;
     }
 
     /**
-     * Return the runtime configurable structure for this task
+     * Return the runtime configurable structure for this task.
      *
-     * @return the runtime structure for this task
+     * @return the runtime structure for this task.
      */
     protected RuntimeConfigurable getWrapper() {
         return wrapper;