diff --git a/src/main/org/apache/tools/ant/AntTypeDefinition.java b/src/main/org/apache/tools/ant/AntTypeDefinition.java index 734a3389a..60953d7dc 100644 --- a/src/main/org/apache/tools/ant/AntTypeDefinition.java +++ b/src/main/org/apache/tools/ant/AntTypeDefinition.java @@ -215,7 +215,7 @@ public class AntTypeDefinition { } /** - * check if the attributes are correct + * Checks if the attributes are correct. *
*
  • if the class can be created.
  • *
  • if an adapter class can be created
  • diff --git a/src/main/org/apache/tools/ant/ComponentHelper.java b/src/main/org/apache/tools/ant/ComponentHelper.java index 63ab4d642..cab1a90fa 100644 --- a/src/main/org/apache/tools/ant/ComponentHelper.java +++ b/src/main/org/apache/tools/ant/ComponentHelper.java @@ -235,9 +235,9 @@ public class ComponentHelper { } /** - * Initialization code - implementing the original ant component + * This method is initialization code implementing the original ant component * loading from /org/apache/tools/ant/taskdefs/default.properties - * and .../types/default.properties + * and /org/apache/tools/ant/types/default.properties. */ public void initDefaultDefinitions() { initTasks(); diff --git a/src/main/org/apache/tools/ant/PropertyHelper.java b/src/main/org/apache/tools/ant/PropertyHelper.java index a309dafba..a73939148 100644 --- a/src/main/org/apache/tools/ant/PropertyHelper.java +++ b/src/main/org/apache/tools/ant/PropertyHelper.java @@ -169,9 +169,9 @@ public class PropertyHelper { /** Get a property. If all hooks return null, the default * tables will be used. * - * @param ns - * @param name - * @return + * @param ns namespace of the sought property + * @param name name of the sought property + * @return The property, if returned by a hook, or null if none. */ public Object getPropertyHook(String ns, String name, boolean user) { if (getNext() != null) { diff --git a/src/main/org/apache/tools/ant/filters/EscapeUnicode.java b/src/main/org/apache/tools/ant/filters/EscapeUnicode.java index 0edc89a8e..6177448fa 100644 --- a/src/main/org/apache/tools/ant/filters/EscapeUnicode.java +++ b/src/main/org/apache/tools/ant/filters/EscapeUnicode.java @@ -20,7 +20,7 @@ import java.io.IOException; import java.io.Reader; /** - * Converts non latin characters to unicode escapes + * This method converts non-latin characters to unicode escapes. * Useful to load properties containing non latin * Example: * diff --git a/src/main/org/apache/tools/ant/helper/ProjectHelper2.java b/src/main/org/apache/tools/ant/helper/ProjectHelper2.java index 3965143bc..0edb206b0 100644 --- a/src/main/org/apache/tools/ant/helper/ProjectHelper2.java +++ b/src/main/org/apache/tools/ant/helper/ProjectHelper2.java @@ -317,8 +317,8 @@ public class ProjectHelper2 extends ProjectHelper { } /** - * Called when this element and all elements nested into it have been - * handled (i.e. at the ). + * This method is called when this element and all elements nested into it have been + * handled. I.e., this happens at the </end_tag_of_the_element>. * @param uri the namespace uri for this element * @param tag the element name * @param context the current context diff --git a/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java b/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java index b0f4f0e9c..278274bd9 100644 --- a/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java @@ -599,7 +599,7 @@ public abstract class AbstractCvsTask extends Task { } /** - * add a command line argument to an external command + * This method adds a command line argument to an external command. * * I do not understand what this method does in this class ??? * particularly not why it is public ???? diff --git a/src/main/org/apache/tools/ant/taskdefs/ExecTask.java b/src/main/org/apache/tools/ant/taskdefs/ExecTask.java index a5eb515c6..fd376b942 100644 --- a/src/main/org/apache/tools/ant/taskdefs/ExecTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/ExecTask.java @@ -357,9 +357,9 @@ public class ExecTask extends Task { /** - * Attempt to figure out where the executable is so that we can feed - * the full path - first try basedir, then the exec dir and then - * fallback to the straight executable name (i.e. on ther path) + * The method attempts to figure out where the executable is so that we can feed + * the full path. We first try basedir, then the exec dir, and then + * fallback to the straight executable name (i.e. on ther path). * * @param exec the name of the executable * @param searchPath if true, the excutable will be looked up in diff --git a/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java b/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java index 9b3c7c51f..5c15062a3 100644 --- a/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java +++ b/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java @@ -41,7 +41,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler { * Construct a new PumpStreamHandler. * @param out the output OutputStream. * @param err the error OutputStream. - * @param in the input InputStream. + * @param input the input InputStream. */ public PumpStreamHandler(OutputStream out, OutputStream err, InputStream input) { diff --git a/src/main/org/apache/tools/ant/taskdefs/Redirector.java b/src/main/org/apache/tools/ant/taskdefs/Redirector.java index 84939c0d8..ade98f77f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Redirector.java +++ b/src/main/org/apache/tools/ant/taskdefs/Redirector.java @@ -360,7 +360,7 @@ public class Redirector { /** * Set the input FilterChains. * - * @param Vector containing FilterChain. + * @param inputFilterChains Vector containing FilterChain. */ public synchronized void setInputFilterChains(Vector inputFilterChains) { this.inputFilterChains = inputFilterChains; @@ -369,7 +369,7 @@ public class Redirector { /** * Set the output FilterChains. * - * @param Vector containing FilterChain. + * @param outputFilterChains Vector containing FilterChain. */ public void setOutputFilterChains(Vector outputFilterChains) { this.outputFilterChains = outputFilterChains; @@ -378,7 +378,7 @@ public class Redirector { /** * Set the error FilterChains. * - * @param Vector containing FilterChain. + * @param errorFilterChains Vector containing FilterChain. */ public void setErrorFilterChains(Vector errorFilterChains) { this.errorFilterChains = errorFilterChains; diff --git a/src/main/org/apache/tools/ant/taskdefs/SubAnt.java b/src/main/org/apache/tools/ant/taskdefs/SubAnt.java index 33391959c..6c109565f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/SubAnt.java +++ b/src/main/org/apache/tools/ant/taskdefs/SubAnt.java @@ -197,9 +197,10 @@ public class SubAnt } /** - * Build file name, to use in conjunction with directories.
    - * Defaults to "build.xml".
    - * If genericantfile is set, this attribute is ignored. + * This method builds the file name to use in conjunction with directories. + * + *

    Defaults to "build.xml". + * If genericantfile is set, this attribute is ignored.

    * * @param antfile the short build file name. Defaults to "build.xml". */ @@ -208,9 +209,10 @@ public class SubAnt } /** - * Build file path, to use in conjunction with directories.
    - * Use genericantfile, in order to run the same build file - * with different basedirs.
    + * This method builds a file path to use in conjunction with directories. + * + *

    Use genericantfile, in order to run the same build file + * with different basedirs.

    * If this attribute is set, antfile is ignored. * * @param afile (path of the generic ant file, absolute or relative to diff --git a/src/main/org/apache/tools/ant/taskdefs/Tar.java b/src/main/org/apache/tools/ant/taskdefs/Tar.java index 6f4c0da0d..5683ba109 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Tar.java +++ b/src/main/org/apache/tools/ant/taskdefs/Tar.java @@ -540,7 +540,7 @@ public class Tar extends MatchingTask { /** * The uid for the tar entry * This is not the same as the User name. - * @param userName the user name for the tar entry. + * @param uid the id of the user for the tar entry. */ public void setUid(int uid) { this.uid = uid; @@ -572,7 +572,7 @@ public class Tar extends MatchingTask { /** * The GID for the tar entry; optional, default="0" * This is not the same as the group name. - * @param groupName the group name string. + * @param gid the group id. */ public void setGid(int gid) { this.gid = gid; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java index 95d6db062..a3a9aa909 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java @@ -361,7 +361,7 @@ public class CSharp extends DotnetCompile { // end execute /** - * how does C# separate references? with a semi colon + * Returns the delimiter which C# uses to separate references, i.e., a semi colon. */ public String getReferenceDelimiter() { return ";"; @@ -369,8 +369,8 @@ public class CSharp extends DotnetCompile { /** - * extension is '.cs' - * @return + * This method indicates the filename extension for C# files. + * @return the file extension for C#, i.e., "cs" (without the dot). */ public String getFileExtension() { return "cs"; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java index 5e6d16223..2f40e5110 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.java @@ -711,8 +711,8 @@ public abstract class DotnetCompile } /** - * what is the executable? - * @return + * This method gets the name of the executable. + * @return the name of the executable */ protected String getExecutable() { return executable; @@ -764,7 +764,7 @@ public abstract class DotnetCompile /** * getter for flag - * @return + * @return The flag indicating whether the compilation is using a response file. */ public boolean isUseResponseFile() { return useResponseFile; @@ -922,8 +922,8 @@ public abstract class DotnetCompile protected abstract void addCompilerSpecificOptions(NetCommand command); /** - * override point for delimiting definitions - * @return + * override point for delimiting definitions. + * @return The definitions limiter, i.e., ";" */ public String getDefinitionsDelimiter() { return ";"; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetDefine.java b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetDefine.java index 27e5eaea1..3fb6dbb49 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetDefine.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetDefine.java @@ -62,10 +62,10 @@ public class DotnetDefine { } /** - * get the value of this definition. Will be null if a condition + * This method gets the value of this definition. Will be null if a condition * was declared and not met * @param owner owning task - * @return + * @return The value of the definition. * @throws BuildException */ public String getValue(Task owner) throws BuildException { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetResource.java b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetResource.java index ad73ba51d..d8f6ac412 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetResource.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetResource.java @@ -98,7 +98,7 @@ public class DotnetResource { /** * build the C# style parameter (which has no public/private option) - * @return + * @return the built C# style parameter */ public String getCSharpStyleParameter() { StringBuffer buffer = new StringBuffer(); @@ -117,8 +117,8 @@ public class DotnetResource { } /** - * get the style of param used by VB and javascript - * @return + * This method gets the style of param used by VB and javascript + * @return The style VB parameter being used. */ public String getVbStyleParameter() { StringBuffer buffer = new StringBuffer(); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/Ildasm.java b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/Ildasm.java index abc25d9b4..2ba44c004 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/Ildasm.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/Ildasm.java @@ -280,7 +280,7 @@ public class Ildasm extends Task { setSourceFile(sourceFile); } /** - * visibility options: one or more of the following, with + signs to + * This method sets the visibility options. It chooses one or more of the following, with + signs to * concatenate them: *
          * pub : Public
    @@ -425,9 +425,9 @@ public class Ildasm extends Task {
             }
     
             /**
    -         * map from an encoding enum to an encoding option
    +         * This method maps from an encoding enum to an encoding option.
              * @param enumValue
    -         * @return
    +         * @return The encoding option indicated by the enum value.
              */
             public static String getEncodingOption(String enumValue) {
                 if (UNICODE.equals(enumValue)) {
    diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/ImportTypelib.java b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/ImportTypelib.java
    index 50bb73fb8..1249b237e 100644
    --- a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/ImportTypelib.java
    +++ b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/ImportTypelib.java
    @@ -76,7 +76,9 @@ public class ImportTypelib extends Task {
         private String extraOptions = null;
     
         /**
    -     * name the output file. required
    +     * This method names the output file.
    +     * 
    +     * This is an operation which is required to have been performed.
          * @param destFile
          */
         public void setDestFile(File destFile) {
    @@ -84,7 +86,8 @@ public class ImportTypelib extends Task {
         }
     
         /**
    -     * what namespace is the typelib to be in. required
    +     * This method sets what namespace the typelib is to be in.
    +     * This is an operation which is required to have been performed.
          * @param namespace
          */
         public void setNamespace(String namespace) {
    @@ -92,7 +95,8 @@ public class ImportTypelib extends Task {
         }
     
         /**
    -     * what is the source .tlb file? required.
    +     * This method sets which is the source .tlb file. 
    +     * This is an operation which is required to have been performed.
          * @param srcFile
          */
         public void setSrcFile(File srcFile) {
    diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java
    index 9b5cca441..9231a6897 100644
    --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java
    +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java
    @@ -292,8 +292,7 @@ public class IPlanetDeploymentTool extends GenericDeploymentTool {
          *
          * @param ejbFiles Hashtable of EJB class (and other) files to be added to
          *                 the completed JAR file.
    -     * @param baseName String name of the EJB JAR file to be written (without
    -     *                 a filename extension).
    +     * @param ddPrefix not used
          */
         protected void addVendorFiles(Hashtable ejbFiles, String ddPrefix) {
             ejbFiles.put(META_DIR + IAS_DD, new File(getConfig().descriptorDir,
    diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java
    index 11b080e62..2e9575136 100644
    --- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java
    +++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java
    @@ -108,9 +108,9 @@ public final class Specification {
             new Compatibility("REQUIRE_IMPLEMENTATION_CHANGE");
     
         /**
    -     * Enum indicating that extension is incompatible with
    +     * This enum indicates that an extension is incompatible with
          * other Package Specification in ways other than other enums
    -     * indicate). ie For example the other Package Specification
    +     * indicate. For example, the other Package Specification
          * may have a different ID.
          */
         public static final Compatibility INCOMPATIBLE =
    diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
    index e0dcb07d8..ce062cc45 100644
    --- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
    +++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
    @@ -298,7 +298,7 @@ public class JspC extends MatchingTask {
     
         /**
          * Filename for web.xml.
    -     * @return
    +     * @return The filename for web.xml.
          */
         public File getWebxml() {
             return this.webxml;
    diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.java
    index 6539079e4..30ecf30bb 100644
    --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.java
    +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.java
    @@ -27,8 +27,8 @@ import org.apache.tools.ant.Project;
     import org.apache.tools.ant.util.StringUtils;
     
     /**
    - *  Syncs an existing Perforce label against the Perforce client
    - *  or against a set of files/revisions
    + *  This method syncs an existing Perforce label against the Perforce client
    + *  or against a set of files/revisions.
      *
      *
      * Example Usage:
    diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.java
    index c86344eaa..d203716e9 100644
    --- a/src/main/org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.java
    +++ b/src/main/org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.java
    @@ -482,7 +482,7 @@ public abstract class TreeBasedTask extends StarTeamTask {
         /**
          * returns the label being used
          *
    -     * @return
    +     * @return the label being used
          */
         protected Label getLabelInUse() {
             return this.labelInUse;
    diff --git a/src/main/org/apache/tools/ant/types/Assertions.java b/src/main/org/apache/tools/ant/types/Assertions.java
    index 87ac3279c..ee5824f7d 100644
    --- a/src/main/org/apache/tools/ant/types/Assertions.java
    +++ b/src/main/org/apache/tools/ant/types/Assertions.java
    @@ -277,7 +277,7 @@ public class Assertions extends DataType implements Cloneable {
             /**
              * create a full command string from this class
              * @throws BuildException in case of trouble
    -         * @return
    +         * @return The command string
              */
             public String toCommand() {
                 //catch invalidness
    diff --git a/src/main/org/apache/tools/ant/types/Commandline.java b/src/main/org/apache/tools/ant/types/Commandline.java
    index 156a2c136..393db82b7 100644
    --- a/src/main/org/apache/tools/ant/types/Commandline.java
    +++ b/src/main/org/apache/tools/ant/types/Commandline.java
    @@ -452,8 +452,8 @@ public class Commandline implements Cloneable {
         }
     
         /**
    -     * a deep clone of the contained object.
    -     * @return
    +     * Generate a deep clone of the contained object.
    +     * @return a clone of the contained object
          */
         public Object clone() {
             try {
    diff --git a/src/main/org/apache/tools/ant/types/CommandlineJava.java b/src/main/org/apache/tools/ant/types/CommandlineJava.java
    index f10a5b430..772653082 100644
    --- a/src/main/org/apache/tools/ant/types/CommandlineJava.java
    +++ b/src/main/org/apache/tools/ant/types/CommandlineJava.java
    @@ -115,9 +115,9 @@ public class CommandlineJava implements Cloneable {
             }
     
             /**
    -         * get the size of the sysproperties instance. This merges all
    +         * This method gets the size of the sysproperties instance. This merges all
              * property sets, so is not an O(1) operation.
    -         * @return
    +         * @return the size of the sysproperties instance
              */
             public int size() {
                 Properties p = mergePropertySets();
    @@ -458,7 +458,7 @@ public class CommandlineJava implements Cloneable {
     
         /**
          * Get the VM command parameters, including memory settings
    -     * @return
    +     * @return the VM command parameters
          */
         protected Commandline getActualVMCommand() {
             Commandline actualVMCommand = (Commandline) vmCommand.clone();
    @@ -557,7 +557,7 @@ public class CommandlineJava implements Cloneable {
     
         /**
          * get the system properties object
    -     * @return
    +     * @return The system properties object
          */
         public SysProperties getSystemProperties() {
             return sysProperties;
    diff --git a/src/main/org/apache/tools/ant/util/ClasspathUtils.java b/src/main/org/apache/tools/ant/util/ClasspathUtils.java
    index 4a3282123..944c00130 100644
    --- a/src/main/org/apache/tools/ant/util/ClasspathUtils.java
    +++ b/src/main/org/apache/tools/ant/util/ClasspathUtils.java
    @@ -78,7 +78,7 @@ public class ClasspathUtils {
          *
          * @param p
          * @param ref
    -     * @return
    +     * @return The class loader
          */
         public static ClassLoader getClassLoaderForPath(
             Project p, Reference ref) {
    @@ -98,7 +98,7 @@ public class ClasspathUtils {
          * @param reverseLoader if set to true this new loader will take
          * precedence over it's parent (which is contra the regular
          * classloader behaviour)
    -     * @return
    +     * @return The class loader
          */
         public static ClassLoader getClassLoaderForPath(
             Project p, Reference ref, boolean reverseLoader) {
    @@ -123,7 +123,7 @@ public class ClasspathUtils {
          *
          * @param path
          * @param loaderId
    -     * @return
    +     * @return The class loader
          */
         public static ClassLoader getClassLoaderForPath(
             Project p, Path path, String loaderId) {
    @@ -140,7 +140,7 @@ public class ClasspathUtils {
          *
          * @param path
          * @param loaderId
    -     * @return
    +     * @return The class loader
          */
         public static ClassLoader getClassLoaderForPath(
             Project p, Path path, String loaderId, boolean reverseLoader) {
    @@ -199,7 +199,7 @@ public class ClasspathUtils {
          * property and should be used with caution.

    * @param path the classpath for this loader * @param reverseLoader - * @return + * @return The fresh, different, not used before class loader. */ public static ClassLoader getUniqueClassLoaderForPath( Project p, @@ -225,7 +225,7 @@ public class ClasspathUtils { * * @param className the full qualified class name to load. * @param userDefinedLoader the classloader to use. - * @return + * @return The fresh object instance * @throws BuildException when loading or instantiation failed. */ public static Object newInstance( @@ -312,7 +312,7 @@ public class ClasspathUtils { } /** - * Delegate method handling the @classpath attribute + * This method is a Delegate method handling the @classpath attribute. * *

    This attribute can set a path to add to the classpath

    * @@ -332,7 +332,7 @@ public class ClasspathUtils { *

    This nested path-like structure can set a path to add to the * classpath

    * - * @return + * @return the created path */ public Path createClasspath() { if (this.classpath == null) { @@ -396,7 +396,7 @@ public class ClasspathUtils { /** * Finds or creates the classloader for this - * @return + * @return The class loader */ public ClassLoader getClassLoader() { ClassLoader cl; diff --git a/src/main/org/apache/tools/zip/ZipOutputStream.java b/src/main/org/apache/tools/zip/ZipOutputStream.java index f10c6f97f..f35ecd096 100644 --- a/src/main/org/apache/tools/zip/ZipOutputStream.java +++ b/src/main/org/apache/tools/zip/ZipOutputStream.java @@ -155,7 +155,7 @@ public class ZipOutputStream extends FilterOutputStream { private static final byte[] LZERO = {0, 0, 0, 0}; /** - * Holds the offsets of the LFH starts for each entry + * Holds the offsets of the LFH starts for each entry. * * @since 1.1 */ @@ -173,7 +173,7 @@ public class ZipOutputStream extends FilterOutputStream { private String encoding = null; /** - * Deflater object for output + * This Deflater object is used for output. * *

    This attribute is only protected to provide a level of API * backwards compatibility. This class used to extend {@link @@ -185,7 +185,7 @@ public class ZipOutputStream extends FilterOutputStream { protected Deflater def = new Deflater(Deflater.DEFAULT_COMPRESSION, true); /** - * Deflater buffer + * This buffer servers as a Deflater. * *

    This attribute is only protected to provide a level of API * backwards compatibility. This class used to extend {@link @@ -197,7 +197,7 @@ public class ZipOutputStream extends FilterOutputStream { protected byte[] buf = new byte[512]; /** - * Optional random access output + * Optional random access output. * * @since 1.14 */ @@ -252,8 +252,8 @@ public class ZipOutputStream extends FilterOutputStream { } /** - * Is this archive writing to a seekable stream (i.e. a random - * access file)? + * This method indicates whether this archive is writing to a seekable stream (i.e., to a random + * access file). * *

    For seekable streams, you don't need to calculate the CRC or * uncompressed size for {@link #STORED STORED} entries before