http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/selectors/modifiedselector/DigestAlgorithm.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/DigestAlgorithm.java b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/DigestAlgorithm.java index 085b4fe..a4b2ffd 100644 --- a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/DigestAlgorithm.java +++ b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/DigestAlgorithm.java @@ -33,23 +33,24 @@ import org.apache.tools.ant.BuildException; /** * Computes a 'hashvalue' for the content of file using * java.security.MessageDigest. - * Use of this algorithm doesn't require any additional nested <param>s. - * Supported <param>s are: + * Use of this algorithm doesn't require any additional nested <param>s. + * Supported <param>s are: * <table> + * <caption>Digest algorithm parameters</caption> * <tr> * <th>name</th><th>values</th><th>description</th><th>required</th> * </tr> * <tr> - * <td> algorithm.algorithm </td> - * <td> MD5 | SHA (default provider) </td> - * <td> name of the algorithm the provider should use </td> - * <td> no, defaults to MD5 </td> + * <td>algorithm.algorithm</td> + * <td>MD5 | SHA (default provider)</td> + * <td>name of the algorithm the provider should use</td> + * <td>no, defaults to MD5</td> * </tr> * <tr> - * <td> algorithm.provider </td> - * <td> </td> - * <td> name of the provider to use </td> - * <td> no, defaults to <i>null</i> </td> + * <td> algorithm.provider</td> + * <td></td> + * <td>name of the provider to use</td> + * <td>no, defaults to <i>null</i></td> * </tr> * </table> *
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/selectors/modifiedselector/HashvalueAlgorithm.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/HashvalueAlgorithm.java b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/HashvalueAlgorithm.java index 8af9d12..ab8849d 100644 --- a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/HashvalueAlgorithm.java +++ b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/HashvalueAlgorithm.java @@ -26,7 +26,7 @@ import org.apache.tools.ant.util.FileUtils; /** * Computes a 'hashvalue' for the content of file using String.hashValue(). - * Use of this algorithm doesn't require any additional nested <param>s and + * Use of this algorithm doesn't require any additional nested <param>s and * doesn't support any. * * @version 2003-09-13 http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java index 9f53809..c59be11 100644 --- a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java @@ -51,16 +51,16 @@ import org.apache.tools.ant.util.ResourceUtils; * in a persistent manner.</p> * * <p>The ModifiedSelector is implemented as a <b>CoreSelector</b> and uses default - * values for all its attributes therefore the simplest example is <pre> + * values for all its attributes therefore the simplest example is</p><pre> * <copy todir="dest"> * <filelist dir="src"> * <modified/> * </filelist> * </copy> - * </pre></p> + * </pre> * * <p>The same example rewritten as CoreSelector with setting the all values - * (same as defaults are) would be <pre> + * (same as defaults are) would be</p><pre> * <copy todir="dest"> * <filelist dir="src"> * <modified update="true" @@ -72,9 +72,9 @@ import org.apache.tools.ant.util.ResourceUtils; * </modified> * </filelist> * </copy> - * </pre></p> + * </pre> * - * <p>And the same rewritten as CustomSelector would be<pre> + * <p>And the same rewritten as CustomSelector would be</p><pre> * <copy todir="dest"> * <filelist dir="src"> * <custom class="org.apache.tools.ant.type.selectors.ModifiedSelector"> @@ -87,18 +87,18 @@ import org.apache.tools.ant.util.ResourceUtils; * </custom> * </filelist> * </copy> - * </pre></p> + * </pre> * * <p>If you want to provide your own interface implementation you can do * that via the *classname attributes. If the classes are not on Ant's core * classpath, you will have to provide the path via nested <classpath> - * element, so that the selector can find the classes. <pre> + * element, so that the selector can find the classes.</p><pre> * <modified cacheclassname="com.mycompany.MyCache"> * <classpath> * <pathelement location="lib/mycompany-antutil.jar"/> * </classpath> * </modified> - * </pre></p> + * </pre> * * <p>All these three examples copy the files from <i>src</i> to <i>dest</i> * using the ModifiedSelector. The ModifiedSelector uses the <i>PropertyfileCache @@ -115,7 +115,7 @@ import org.apache.tools.ant.util.ResourceUtils; * * <p>A useful scenario for this selector is inside a build environment * for homepage generation (e.g. with <a href="http://forrest.apache.org/";> - * Apache Forrest</a>). <pre> + * Apache Forrest</a>).</p><pre> * <target name="generate-and-upload-site"> * <echo> generate the site using forrest </echo> * <antcall target="site"/> @@ -127,7 +127,7 @@ import org.apache.tools.ant.util.ResourceUtils; * </fileset> * </ftp> * </target> - * </pre> Here all <b>changed</b> files are uploaded to the server. The + * </pre><p>Here all <b>changed</b> files are uploaded to the server. The * ModifiedSelector saves therefore much upload time.</p> * * @@ -178,7 +178,7 @@ public class ModifiedSelector extends BaseExtendSelector private boolean selectDirectories = true; /** - * Should Resources whithout an InputStream, and + * Should Resources without an InputStream, and * therefore without checking, be selected? */ private boolean selectResourcesWithoutInputStream = true; @@ -255,14 +255,14 @@ public class ModifiedSelector extends BaseExtendSelector /** * Configures this Selector. * Does this work only once per Selector object. - * <p>Because some problems while configuring from <custom>Selector - * the configuration is done in the following order:<ol> - * <li> collect the configuration data </li> - * <li> wait for the first isSelected() call </li> - * <li> set the default values </li> - * <li> set values for name pattern '*': update, cache, algorithm, comparator </li> - * <li> set values for name pattern '*.*: cache.cachefile, ... </li> - * </ol></p> + * <p>Because some problems while configuring from <custom>Selector + * the configuration is done in the following order:</p><ol> + * <li>collect the configuration data</li> + * <li>wait for the first isSelected() call</li> + * <li>set the default values</li> + * <li>set values for name pattern '*': update, cache, algorithm, comparator</li> + * <li>set values for name pattern '*.*: cache.cachefile, ...</li> + * </ol> * <p>This configuration algorithm is needed because you don't know * the order of arriving config-data. E.g. if you first set the * <i>cache.cachefilename</i> and after that the <i>cache</i> itself, @@ -391,6 +391,7 @@ public class ModifiedSelector extends BaseExtendSelector * Loads the specified class and initializes an object of that class. * Throws a BuildException using the given message if an error occurs during * loading/instantiation or if the object is not from the given type. + * @param <T> desired type * @param classname the classname * @param msg the message-part for the BuildException * @param type the type to check against @@ -457,7 +458,7 @@ public class ModifiedSelector extends BaseExtendSelector log("The resource '" + resource.getName() + "' does not provide an InputStream, so it is not checked. " - + "Akkording to 'selres' attribute value it is " + + "According to 'selres' attribute value it is " + ((selectResourcesWithoutInputStream) ? "" : " not") + "selected.", Project.MSG_INFO); return selectResourcesWithoutInputStream; @@ -690,7 +691,7 @@ public class ModifiedSelector extends BaseExtendSelector * Defined in org.apache.tools.ant.types.Parameterizable. * Overwrite implementation in superclass because only special * parameters are valid. - * @see #addParam(String,Object). + * @see #addParam(String,Object) * @param parameters the parameters to set. */ public void setParameters(Parameter[] parameters) { @@ -703,7 +704,7 @@ public class ModifiedSelector extends BaseExtendSelector /** - * Support for nested <param name="" value=""/> tags. + * Support for nested <code><param name="" value=""/></code> tags. * Parameter named <i>cache</i>, <i>algorithm</i>, * <i>comparator</i> or <i>update</i> are mapped to * the respective set-Method. http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.java b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.java index e8cf3fe..c856d56 100644 --- a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.java +++ b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.java @@ -33,22 +33,23 @@ import java.util.Vector; /** * Use java.util.Properties for storing the values. * The use of this Cache-implementation requires the use of the parameter - * <param name="cache.cachefile" .../> for defining, where to store the + * <param name="cache.cachefile" .../> for defining, where to store the * properties file. * * The ModifiedSelector sets the <i>cachefile</i> to the default value * <i>cache.properties</i>. * - * Supported <param>s are: + * Supported <param>s are: * <table> + * <caption>Cache parameters</caption> * <tr> * <th>name</th><th>values</th><th>description</th><th>required</th> * </tr> * <tr> - * <td> cache.cachefile </td> - * <td> <i>path to file</i> </td> - * <td> the name of the properties file </td> - * <td> yes </td> + * <td>cache.cachefile</td> + * <td><i>path to file</i></td> + * <td>the name of the properties file</td> + * <td>yes</td> * </tr> * </table> * http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/ClasspathUtils.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/ClasspathUtils.java b/src/main/org/apache/tools/ant/util/ClasspathUtils.java index 309860e..8b24610 100644 --- a/src/main/org/apache/tools/ant/util/ClasspathUtils.java +++ b/src/main/org/apache/tools/ant/util/ClasspathUtils.java @@ -214,9 +214,8 @@ public class ClasspathUtils { /** * Creates a fresh object instance of the specified classname. * - * <p> This uses the userDefinedLoader to load the specified class, - * and then makes an instance using the default no-argument constructor. - * </p> + * <p>This uses the userDefinedLoader to load the specified class, + * and then makes an instance using the default no-argument constructor.</p> * * @param className the full qualified class name to load. * @param userDefinedLoader the classloader to use. @@ -230,9 +229,8 @@ public class ClasspathUtils { /** * Creates a fresh object instance of the specified classname. * - * <p> This uses the userDefinedLoader to load the specified class, - * and then makes an instance using the default no-argument constructor. - * </p> + * <p>This uses the userDefinedLoader to load the specified class, + * and then makes an instance using the default no-argument constructor.</p> * * @param className the full qualified class name to load. * @param userDefinedLoader the classloader to use. @@ -270,7 +268,7 @@ public class ClasspathUtils { /** * Obtains a delegate that helps out with classic classpath configuration. * - * @param component your projectComponent that needs the assistence + * @param component your projectComponent that needs the assistance * @return the helper, delegate. * @see ClasspathUtils.Delegate */ @@ -294,13 +292,13 @@ public class ClasspathUtils { * Classes and instantiate them often expose the following ant syntax * sugar: </p> * - * <ul><li> nested <classpath> </li> - * <li> attribute @classpathref </li> - * <li> attribute @classname </li></ul> + * <ul><li>nested <classpath></li> + * <li>attribute @classpathref</li> + * <li>attribute @classname</li></ul> * - * <p> This class functions as a delegate handling the configuration + * <p>This class functions as a delegate handling the configuration * issues for this recurring pattern. Its usage pattern, as the name - * suggests, is delegation rather than inheritance. </p> + * suggests, is delegation rather than inheritance.</p> * * @since Ant 1.6 */ http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/ConcatResourceInputStream.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/ConcatResourceInputStream.java b/src/main/org/apache/tools/ant/util/ConcatResourceInputStream.java index 7bae58e..6c68747 100644 --- a/src/main/org/apache/tools/ant/util/ConcatResourceInputStream.java +++ b/src/main/org/apache/tools/ant/util/ConcatResourceInputStream.java @@ -126,7 +126,7 @@ public class ConcatResourceInputStream extends InputStream { if (!r.isExists()) { continue; } - log("Concating " + r.toLongString(), Project.MSG_VERBOSE); + log("Concatenating " + r.toLongString(), Project.MSG_VERBOSE); try { currentStream = new BufferedInputStream(r.getInputStream()); return; http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/DOMElementWriter.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/DOMElementWriter.java b/src/main/org/apache/tools/ant/util/DOMElementWriter.java index cafecf0..1221cf2 100644 --- a/src/main/org/apache/tools/ant/util/DOMElementWriter.java +++ b/src/main/org/apache/tools/ant/util/DOMElementWriter.java @@ -414,7 +414,7 @@ public class DOMElementWriter { } /** - * Escape <, > & ', " as their entities and + * Escape <, >, &, ', " as their entities and * drop characters that are illegal in XML documents. * @param value the string to encode. * @return the encoded string. @@ -424,7 +424,7 @@ public class DOMElementWriter { } /** - * Escape <, > & ', " as their entities, \n, + * Escape <, >, &, ', " as their entities, \n, * \r and \t as numeric entities and drop characters that are * illegal in XML documents. * @param value the string to encode. @@ -514,6 +514,7 @@ public class DOMElementWriter { * href="http://www.w3.org/TR/1998/REC-xml-19980210#sec-cdata-sect";>http://www.w3.org/TR/1998/REC-xml-19980210#sec-cdata-sect</a>.</p> * @param value the value to be encoded. * @param out where to write the encoded data to. + * @throws IOException if data cannot be written */ public void encodedata(final Writer out, final String value) throws IOException { final int len = value.length(); http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/DateUtils.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/DateUtils.java b/src/main/org/apache/tools/ant/util/DateUtils.java index 016ce9d..af6fd87 100644 --- a/src/main/org/apache/tools/ant/util/DateUtils.java +++ b/src/main/org/apache/tools/ant/util/DateUtils.java @@ -153,7 +153,7 @@ public final class DateUtils { /** - * Format an elapsed time into a plurialization correct string. + * Format an elapsed time into a pluralization correct string. * It is limited only to report elapsed time in minutes and * seconds and has the following behavior. * <ul> @@ -196,7 +196,7 @@ public final class DateUtils { * moon period = 29.53058 days ~= 30, year = 365.2422 days * * days moon phase advances on first day of year compared to preceding year - * = 365.2422 - 12*29.53058 ~= 11 + * = 365.2422 - 12 * 29.53058 ~= 11 * * years in Metonic cycle (time until same phases fall on the same days of * the month) = 18.6 ~= 19 @@ -208,7 +208,7 @@ public final class DateUtils { * * 6 moons ~= 177 days * 177 ~= 8 reported phases * 22 - * + 11/22 for rounding + * + 11 / 22 for rounding * </pre> * * @param cal the calendar. @@ -351,23 +351,32 @@ public final class DateUtils { * where {a|b} indicates that you must choose one of a or b, and [c] * indicates that you may use or omit c. ±ZZZZ is the timezone offset, and * may be literally "Z" to mean GMT. + * + * @param dateStr String + * @return Date + * @throws ParseException if date string does not match ISO 8601 * @since Ant 1.9.10 */ public static Date parseLenientDateTime(String dateStr) throws ParseException { try { return new Date(Long.parseLong(dateStr)); - } catch (NumberFormatException nfe) {} + } catch (NumberFormatException ignored) { + } try { return EN_US_DATE_FORMAT_MIN.get().parse(dateStr); - } catch (ParseException pe) {} + } catch (ParseException ignored) { + } try { return EN_US_DATE_FORMAT_SEC.get().parse(dateStr); - } catch (ParseException pe) {} + } catch (ParseException ignored) { + } Matcher m = iso8601normalizer.matcher(dateStr); - if (!m.find()) throw new ParseException(dateStr, 0); + if (!m.find()) { + throw new ParseException(dateStr, 0); + } String normISO = m.group(1) + " " + (m.group(3) == null ? m.group(2) + ":00" : m.group(2)) + (m.group(4) == null ? ".000 " : " ") http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/FileUtils.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/FileUtils.java b/src/main/org/apache/tools/ant/util/FileUtils.java index b22f517..c36eae7 100644 --- a/src/main/org/apache/tools/ant/util/FileUtils.java +++ b/src/main/org/apache/tools/ant/util/FileUtils.java @@ -93,7 +93,7 @@ public class FileUtils { /** * A one item cache for fromUri. - * fromUri is called for each element when parseing ant build + * fromUri is called for each element when parsing ant build * files. It is a costly operation. This just caches the result * of the last call. */ @@ -1259,6 +1259,11 @@ public class FileUtils { /** * Are the two File instances pointing to the same object on the * file system? + * + * @param f1 File + * @param f2 File + * @return boolean + * @throws IOException if file name canonicalization fails * @since Ant 1.8.2 */ public boolean areSame(File f1, File f2) throws IOException { @@ -1285,11 +1290,9 @@ public class FileUtils { * * @param from the file to move. * @param to the new file name. - * * @throws IOException if anything bad happens during this * process. Note that <code>to</code> may have been deleted * already when this happens. - * * @since Ant 1.6 */ public void rename(File from, File to) throws IOException { @@ -1346,18 +1349,20 @@ public class FileUtils { * test whether a file or directory exists, with an error in the * upper/lower case spelling of the name. * Using this method is only interesting on case insensitive file systems - * (Windows).<br> - * It will return true only if 3 conditions are met : - * <br> + * (Windows). + * <p> + * It will return true only if 3 conditions are met: + * </p> * <ul> * <li>operating system is case insensitive</li> * <li>file exists</li> * <li>actual name from directory reading is different from the * supplied argument</li> * </ul> - * <br> - * the purpose is to identify files or directories on case-insensitive - * filesystems whose case is not what is expected.<br> + * <p> + * The purpose is to identify files or directories on case-insensitive + * filesystems whose case is not what is expected. + * </p> * Possibly to rename them afterwards to the desired upper/lowercase * combination. * @@ -1559,6 +1564,7 @@ public class FileUtils { * Others possible. If the delete does not work, call System.gc(), * wait a little and try again. * + * @param f File * @return whether deletion was successful * @since Ant 1.8.0 */ @@ -1570,6 +1576,8 @@ public class FileUtils { * If delete does not work, call System.gc() if asked to, wait a * little and try again. * + * @param f File + * @param runGC boolean * @return whether deletion was successful * @since Ant 1.8.3 */ @@ -1678,7 +1686,7 @@ public class FileUtils { /** * Gets path from a <code>List</code> of <code>String</code>s. * - * @param pathStack <code>List</code> of <code>String</code>s to be concated as a path. + * @param pathStack <code>List</code> of <code>String</code>s to be concatenated as a path. * @param separatorChar <code>char</code> to be used as separator between names in path * @return <code>String</code>, never <code>null</code> * http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/GlobPatternMapper.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/GlobPatternMapper.java b/src/main/org/apache/tools/ant/util/GlobPatternMapper.java index da2a0f1..ebba54e 100644 --- a/src/main/org/apache/tools/ant/util/GlobPatternMapper.java +++ b/src/main/org/apache/tools/ant/util/GlobPatternMapper.java @@ -86,6 +86,7 @@ public class GlobPatternMapper implements FileNameMapper { /** * Attribute specifying whether to ignore the difference * between / and \ (the two common directory characters). + * @return boolean * @since Ant 1.8.3 */ public boolean getHandleDirSep() { http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/IdentityStack.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/IdentityStack.java b/src/main/org/apache/tools/ant/util/IdentityStack.java index ac806d7..ba435b1 100644 --- a/src/main/org/apache/tools/ant/util/IdentityStack.java +++ b/src/main/org/apache/tools/ant/util/IdentityStack.java @@ -33,6 +33,7 @@ public class IdentityStack<E> extends Stack<E> { /** * Get an IdentityStack containing the contents of the specified Stack. + * @param <E> desired type * @param s the Stack to copy; ignored if null. * @return an IdentityStack instance. */ http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/JavaEnvUtils.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/JavaEnvUtils.java b/src/main/org/apache/tools/ant/util/JavaEnvUtils.java index 359174a..2fc36b2 100644 --- a/src/main/org/apache/tools/ant/util/JavaEnvUtils.java +++ b/src/main/org/apache/tools/ant/util/JavaEnvUtils.java @@ -132,7 +132,7 @@ public final class JavaEnvUtils { /** Whether this is the Kaffe VM */ private static boolean kaffeDetected; - /** Wheter this is a GNU Classpath based VM */ + /** Whether this is a GNU Classpath based VM */ private static boolean classpathDetected; /** Whether this is the GNU VM (gcj/gij) */ @@ -566,22 +566,21 @@ public final class JavaEnvUtils { } /** - * * Writes the command into a temporary DCL script and returns the * corresponding File object. * It is the job of the caller to delete the file on exit. - * @param cmd the command. + * @param cmds the command. * @return the file containing the command. * @throws IOException if there is an error writing to the file. */ - public static File createVmsJavaOptionFile(String[] cmd) + public static File createVmsJavaOptionFile(String[] cmds) throws IOException { File script = FILE_UTILS.createTempFile("ANT", ".JAVA_OPTS", null, false, true); BufferedWriter out = null; try { out = new BufferedWriter(new FileWriter(script)); - for (int i = 0; i < cmd.length; i++) { - out.write(cmd[i]); + for (int i = 0; i < cmds.length; i++) { + out.write(cmds[i]); out.newLine(); } } finally { http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java b/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java index debde59..58332b5 100644 --- a/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java +++ b/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java @@ -58,6 +58,7 @@ public class KeepAliveInputStream extends FilterInputStream { * Convenience factory method that returns a non-closing * InputStream around System.in. * + * @return InputStream * @since Ant 1.8.0 */ public static InputStream wrapSystemIn() { http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java b/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java index 27f3d7e..352b0ba 100644 --- a/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java +++ b/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java @@ -58,6 +58,7 @@ public class KeepAliveOutputStream extends FilterOutputStream { * Convenience factory method that returns a non-closing * PrintStream around System.out. * + * @return PrintStream * @since Ant 1.8.0 */ public static PrintStream wrapSystemOut() { @@ -68,6 +69,7 @@ public class KeepAliveOutputStream extends FilterOutputStream { * Convenience factory method that returns a non-closing * PrintStream around System.err. * + * @return PrintStream * @since Ant 1.8.0 */ public static PrintStream wrapSystemErr() { @@ -75,6 +77,7 @@ public class KeepAliveOutputStream extends FilterOutputStream { } /** + * @return PrintStream * @since Ant 1.8.0 */ private static PrintStream wrap(PrintStream ps) { http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/LayoutPreservingProperties.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/LayoutPreservingProperties.java b/src/main/org/apache/tools/ant/util/LayoutPreservingProperties.java index eceb9a0..116a431 100644 --- a/src/main/org/apache/tools/ant/util/LayoutPreservingProperties.java +++ b/src/main/org/apache/tools/ant/util/LayoutPreservingProperties.java @@ -248,6 +248,7 @@ public class LayoutPreservingProperties extends Properties { /** * Save the properties to a file. * @param dest the file to write to + * @throws IOException if save fails */ public void saveAs(final File dest) throws IOException { final FileOutputStream fos = new FileOutputStream(dest); @@ -271,7 +272,7 @@ public class LayoutPreservingProperties extends Properties { } } - // we may be updatiung a file written by this class, replace + // we may be updating a file written by this class, replace // the date comment instead of adding a new one and preserving // the one written last time if (totalLines > skipLines @@ -308,7 +309,7 @@ public class LayoutPreservingProperties extends Properties { /** * Reads a properties file into an internally maintained - * collection of logical lines (possibly spanning physcial lines), + * collection of logical lines (possibly spanning physical lines), * which make up the comments, blank lines and properties of the * file. * @param is the stream from which to read the data @@ -432,7 +433,7 @@ public class LayoutPreservingProperties extends Properties { } /** - * Unescape the string according to the rules for a Properites + * Unescape the string according to the rules for a Properties * file, as laid out in the docs for <a * href="http://java.sun.com/j2se/1.3/docs/api/java/util/Properties.html";>java.util.Properties</a>. * @param s the string to unescape (coming from the source file) @@ -442,7 +443,7 @@ public class LayoutPreservingProperties extends Properties { /* * The following combinations are converted: * \n newline - * \r carraige return + * \r carriage return * \f form feed * \t tab * \\ backslash @@ -574,7 +575,7 @@ public class LayoutPreservingProperties extends Properties { } /** - * Remove the comments in the leading up the {@link logicalLines} + * Remove the comments in the leading up the {@link #logicalLines} * list leading up to line <code>pos</code>. * @param pos the line number to which the comments lead */ @@ -655,7 +656,7 @@ public class LayoutPreservingProperties extends Properties { /** * A key-value pair from the input stream. This may span more than - * one physical line, but it is constitutes as a single logical + * one physical line, but it is constitues as a single logical * line. */ private static class Pair extends LogicalLine implements Cloneable { http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/MergingMapper.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/MergingMapper.java b/src/main/org/apache/tools/ant/util/MergingMapper.java index 7f158db..f148e8b 100644 --- a/src/main/org/apache/tools/ant/util/MergingMapper.java +++ b/src/main/org/apache/tools/ant/util/MergingMapper.java @@ -34,6 +34,7 @@ public class MergingMapper implements FileNameMapper { public MergingMapper() {} /** + * @param to String * @since Ant 1.8.0 */ public MergingMapper(String to) { http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/ProcessUtil.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/ProcessUtil.java b/src/main/org/apache/tools/ant/util/ProcessUtil.java index f6e71b1..998c713 100644 --- a/src/main/org/apache/tools/ant/util/ProcessUtil.java +++ b/src/main/org/apache/tools/ant/util/ProcessUtil.java @@ -30,7 +30,7 @@ public class ProcessUtil { /** * provide id of the current process - * @param fallback + * @param fallback fallback id * @return current process id */ public static String getProcessId(final String fallback) { http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/ReflectUtil.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/ReflectUtil.java b/src/main/org/apache/tools/ant/util/ReflectUtil.java index ed8b47a..b10ef39 100644 --- a/src/main/org/apache/tools/ant/util/ReflectUtil.java +++ b/src/main/org/apache/tools/ant/util/ReflectUtil.java @@ -40,6 +40,11 @@ public class ReflectUtil { /** * Create an instance of a class using the constructor matching * the given arguments. + * @param <T> desired type + * @param ofClass Class<T> + * @param argTypes Class<?>[] + * @param args Object[] + * @return class instance * @since Ant 1.8.0 */ public static <T> T newInstance(Class<T> ofClass, http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/ScriptRunnerBase.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/ScriptRunnerBase.java b/src/main/org/apache/tools/ant/util/ScriptRunnerBase.java index b8aa01a..5e2857e 100644 --- a/src/main/org/apache/tools/ant/util/ScriptRunnerBase.java +++ b/src/main/org/apache/tools/ant/util/ScriptRunnerBase.java @@ -205,7 +205,7 @@ public abstract class ScriptRunnerBase { /** * Read some source in from the given reader - * @param reader the reader; this is closed afterwards. + * @param in the input stream to pass into a buffered reader. * @param name the name to use in error messages */ private void readSource(Reader reader, String name) { http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/ScriptRunnerCreator.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/ScriptRunnerCreator.java b/src/main/org/apache/tools/ant/util/ScriptRunnerCreator.java index 6ce3c7e..bf3c2c9 100644 --- a/src/main/org/apache/tools/ant/util/ScriptRunnerCreator.java +++ b/src/main/org/apache/tools/ant/util/ScriptRunnerCreator.java @@ -101,7 +101,7 @@ public class ScriptRunnerCreator { * in manager. * This checks if the script manager exists in the scriptLoader * classloader and if so it creates and returns the script runner. - * @param checkManager check if the manager matchs this value. + * @param checkManager check if the manager matches this value. * @param managerClass the name of the script manager class. * @param runnerClass the name of ant's script runner for this manager. * @return the script runner class. http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/ScriptRunnerHelper.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/ScriptRunnerHelper.java b/src/main/org/apache/tools/ant/util/ScriptRunnerHelper.java index 9e814d9..e25811d 100644 --- a/src/main/org/apache/tools/ant/util/ScriptRunnerHelper.java +++ b/src/main/org/apache/tools/ant/util/ScriptRunnerHelper.java @@ -99,7 +99,7 @@ public class ScriptRunnerHelper { } /** - * Load the script from an external file ; optional. + * Load the script from an external file; optional. * * @param file the file containing the script source. */ http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/SplitClassLoader.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/SplitClassLoader.java b/src/main/org/apache/tools/ant/util/SplitClassLoader.java index f48d3d3..9d657da 100644 --- a/src/main/org/apache/tools/ant/util/SplitClassLoader.java +++ b/src/main/org/apache/tools/ant/util/SplitClassLoader.java @@ -31,7 +31,10 @@ public final class SplitClassLoader extends AntClassLoader { private final String[] splitClasses; /** - * @param splitClasses classes contained herin will not be loaded + * @param parent ClassLoader + * @param path Path + * @param project Project + * @param splitClasses classes contained herein will not be loaded * via Ant's classloader */ public SplitClassLoader(ClassLoader parent, Path path, Project project, http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/SymbolicLinkUtils.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/SymbolicLinkUtils.java b/src/main/org/apache/tools/ant/util/SymbolicLinkUtils.java index 62b7a3f..20975dd 100644 --- a/src/main/org/apache/tools/ant/util/SymbolicLinkUtils.java +++ b/src/main/org/apache/tools/ant/util/SymbolicLinkUtils.java @@ -121,7 +121,7 @@ public class SymbolicLinkUtils { * * <p>Note that #isSymbolicLink returns false if this method * returns true since Java won't produce a canonical name - * different from the abolute one if the link is broken.</p> + * different from the absolute one if the link is broken.</p> * * @param name the name of the file to test. * @@ -142,7 +142,7 @@ public class SymbolicLinkUtils { * * <p>Note that #isSymbolicLink returns false if this method * returns true since Java won't produce a canonical name - * different from the abolute one if the link is broken.</p> + * different from the absolute one if the link is broken.</p> * * @param file the file to test. * @@ -163,7 +163,7 @@ public class SymbolicLinkUtils { * * <p>Note that #isSymbolicLink returns false if this method * returns true since Java won't produce a canonical name - * different from the abolute one if the link is broken.</p> + * different from the absolute one if the link is broken.</p> * * @param parent the parent directory of the file to test * @param name the name of the file to test. http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/TimeoutObserver.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/TimeoutObserver.java b/src/main/org/apache/tools/ant/util/TimeoutObserver.java index ba2e0c7..c142d3c 100644 --- a/src/main/org/apache/tools/ant/util/TimeoutObserver.java +++ b/src/main/org/apache/tools/ant/util/TimeoutObserver.java @@ -29,7 +29,7 @@ package org.apache.tools.ant.util; public interface TimeoutObserver { /** - * Called when the watchdow times out. + * Called when the watchdog times out. * * @param w the watchdog that timed out. */ http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/UUEncoder.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/UUEncoder.java b/src/main/org/apache/tools/ant/util/UUEncoder.java index c42dcab..b0c6737 100644 --- a/src/main/org/apache/tools/ant/util/UUEncoder.java +++ b/src/main/org/apache/tools/ant/util/UUEncoder.java @@ -99,11 +99,10 @@ public class UUEncoder { * Encode a single line of data (less than or equal to 45 characters). * * @param data The array of byte data. - * @param off The starting offset within the data. + * @param offset The starting offset within the data. * @param length Length of the data to encode. * @param out The output stream the encoded data is written to. - * - * @exception IOException + * @exception IOException if something goes wrong */ private void encodeLine( byte[] data, int offset, int length, OutputStream out) http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/UnicodeUtil.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/UnicodeUtil.java b/src/main/org/apache/tools/ant/util/UnicodeUtil.java index d3e5eec..86199d4 100644 --- a/src/main/org/apache/tools/ant/util/UnicodeUtil.java +++ b/src/main/org/apache/tools/ant/util/UnicodeUtil.java @@ -29,7 +29,7 @@ public class UnicodeUtil { /** * returns the unicode representation of a char without the leading backslash - * @param ch + * @param ch a character * @return unicode representation of a char for property files */ public static StringBuffer EscapeUnicode(char ch) { http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/WeakishReference.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/WeakishReference.java b/src/main/org/apache/tools/ant/util/WeakishReference.java index 92f322f..9568a28 100644 --- a/src/main/org/apache/tools/ant/util/WeakishReference.java +++ b/src/main/org/apache/tools/ant/util/WeakishReference.java @@ -43,7 +43,7 @@ public class WeakishReference { * create a new soft reference, which is bound to a * Weak reference inside * - * @param reference + * @param reference ditto * @see java.lang.ref.WeakReference */ WeakishReference(Object reference) { http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/WorkerAnt.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/WorkerAnt.java b/src/main/org/apache/tools/ant/util/WorkerAnt.java index 768f387..b22be50 100644 --- a/src/main/org/apache/tools/ant/util/WorkerAnt.java +++ b/src/main/org/apache/tools/ant/util/WorkerAnt.java @@ -23,12 +23,12 @@ import org.apache.tools.ant.Task; /** * A worker ant executes a single task in a background thread. - * After the run, any exception thrown is turned into a buildexception, which can be + * After the run, any exception thrown is turned into a BuildException, which can be * rethrown, the finished attribute is set, then notifyAll() is called, * so that anyone waiting on the same notify object gets woken up. * <p> * This class is effectively a superset of - * {@link org.apache.tools.ant.taskdefs.Parallel.TaskRunnable} + * <code>org.apache.tools.ant.taskdefs.Parallel.TaskRunnable</code> * * @since Ant 1.8 */ http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java b/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java index a312ff4..b5ef999 100644 --- a/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java +++ b/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java @@ -38,7 +38,7 @@ public abstract class AbstractAnalyzer implements DependencyAnalyzer { /** The source path for the source files */ private Path sourcePath = new Path(null); - /** The classpath containg dirs and jars of class files */ + /** The classpath containing dirs and jars of class files */ private Path classPath = new Path(null); /** The list of root classes */ http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/regexp/JakartaOroRegexp.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/regexp/JakartaOroRegexp.java b/src/main/org/apache/tools/ant/util/regexp/JakartaOroRegexp.java index 529a78a..32cebeb 100644 --- a/src/main/org/apache/tools/ant/util/regexp/JakartaOroRegexp.java +++ b/src/main/org/apache/tools/ant/util/regexp/JakartaOroRegexp.java @@ -84,7 +84,7 @@ public class JakartaOroRegexp extends JakartaOroMatcher implements Regexp { * Convert ant regexp substitution option to oro options. * * @param options the ant regexp options - * @return the oro substition options + * @return the oro substitution options */ protected int getSubsOptions(final int options) { final boolean replaceAll = RegexpUtil.hasFlag(options, REPLACE_ALL); http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/regexp/JakartaRegexpRegexp.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/regexp/JakartaRegexpRegexp.java b/src/main/org/apache/tools/ant/util/regexp/JakartaRegexpRegexp.java index 865f424..cdb6de9 100644 --- a/src/main/org/apache/tools/ant/util/regexp/JakartaRegexpRegexp.java +++ b/src/main/org/apache/tools/ant/util/regexp/JakartaRegexpRegexp.java @@ -38,7 +38,7 @@ public class JakartaRegexpRegexp extends JakartaRegexpMatcher * Convert ant regexp substitution option to apache regex options. * * @param options the ant regexp options - * @return the apache regex substition options + * @return the apache regex substitution options */ protected int getSubsOptions(int options) { int subsOptions = RE.REPLACE_FIRSTONLY; http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/regexp/Jdk14RegexpRegexp.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/regexp/Jdk14RegexpRegexp.java b/src/main/org/apache/tools/ant/util/regexp/Jdk14RegexpRegexp.java index 3ca8070..de0054f 100644 --- a/src/main/org/apache/tools/ant/util/regexp/Jdk14RegexpRegexp.java +++ b/src/main/org/apache/tools/ant/util/regexp/Jdk14RegexpRegexp.java @@ -38,7 +38,7 @@ public class Jdk14RegexpRegexp extends Jdk14RegexpMatcher implements Regexp { * Convert ant regexp substitution option to jdk1.4 options. * * @param options the ant regexp options - * @return the jdk14 substition options + * @return the jdk14 substitution options */ protected int getSubsOptions(int options) { int subsOptions = REPLACE_FIRST; http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/regexp/RegexpMatcherFactory.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/regexp/RegexpMatcherFactory.java b/src/main/org/apache/tools/ant/util/regexp/RegexpMatcherFactory.java index a0a8a15..4f2082d 100644 --- a/src/main/org/apache/tools/ant/util/regexp/RegexpMatcherFactory.java +++ b/src/main/org/apache/tools/ant/util/regexp/RegexpMatcherFactory.java @@ -104,7 +104,7 @@ public class RegexpMatcherFactory { public static boolean regexpMatcherPresent(Project project) { try { // The factory throws a BuildException if no usable matcher - // cannot be instantiated. We dont need the matcher itself here. + // cannot be instantiated. We don't need the matcher itself here. new RegexpMatcherFactory().newRegexpMatcher(project); return true; } catch (Throwable ex) { http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/util/regexp/RegexpUtil.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/ant/util/regexp/RegexpUtil.java b/src/main/org/apache/tools/ant/util/regexp/RegexpUtil.java index ebd85fa..18fb95a 100644 --- a/src/main/org/apache/tools/ant/util/regexp/RegexpUtil.java +++ b/src/main/org/apache/tools/ant/util/regexp/RegexpUtil.java @@ -50,10 +50,10 @@ public class RegexpUtil { /** * convert regex option flag characters to regex options * <dl> - * <li>g - Regexp.REPLACE_ALL</li> - * <li>i - RegexpMatcher.MATCH_CASE_INSENSITIVE</li> - * <li>m - RegexpMatcher.MATCH_MULTILINE</li> - * <li>s - RegexpMatcher.MATCH_SINGLELINE</li> + * <dt>g</dt><dd>Regexp.REPLACE_ALL</dd> + * <dt>i</dt><dd>RegexpMatcher.MATCH_CASE_INSENSITIVE</dd> + * <dt>m</dt><dd>RegexpMatcher.MATCH_MULTILINE</dd> + * <dt>s</dt><dd>RegexpMatcher.MATCH_SINGLELINE</dd> * </dl> * @param flags the string containing the flags * @return the Regexp option bits http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/bzip2/BlockSort.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/bzip2/BlockSort.java b/src/main/org/apache/tools/bzip2/BlockSort.java index 46c6a5c..0a50fdf 100644 --- a/src/main/org/apache/tools/bzip2/BlockSort.java +++ b/src/main/org/apache/tools/bzip2/BlockSort.java @@ -141,7 +141,7 @@ class BlockSort { /** * Array instance identical to Data's sfmap, both are used only - * temporarily and indepently, so we do not need to allocate + * temporarily and independently, so we do not need to allocate * additional memory. */ private final char[] quadrant; @@ -467,7 +467,6 @@ class BlockSort { * partially sorted order * @param block the original data * @param nblock size of the block - * @param off offset of first byte to sort in block */ final void fallbackSort(int[] fmap, byte[] block, int nblock) { final int[] ftab = new int[257]; http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/bzip2/CBZip2InputStream.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/bzip2/CBZip2InputStream.java b/src/main/org/apache/tools/bzip2/CBZip2InputStream.java index 73b6aa1..7563a40 100644 --- a/src/main/org/apache/tools/bzip2/CBZip2InputStream.java +++ b/src/main/org/apache/tools/bzip2/CBZip2InputStream.java @@ -108,7 +108,7 @@ public class CBZip2InputStream extends InputStream implements BZip2Constants { /** * Constructs a new CBZip2InputStream which decompresses bytes read from - * the specified stream. This doesn't suppprt decompressing + * the specified stream. This doesn't support decompressing * concatenated .bz2 files. * * <p>Although BZip2 headers are marked with the magic @@ -117,6 +117,7 @@ public class CBZip2InputStream extends InputStream implements BZip2Constants { * to skip the first two bytes. Otherwise this constructor will * throw an exception. </p> * + * @param in InputStream * @throws IOException * if the stream content is malformed or an I/O error occurs. * @throws NullPointerException @@ -691,7 +692,6 @@ public class CBZip2InputStream extends InputStream implements BZip2Constants { if (thech >= 0) { bsBuffShadow = (bsBuffShadow << 8) | thech; bsLiveShadow += 8; - continue; } else { throw new IOException("unexpected end of stream"); } @@ -706,7 +706,6 @@ public class CBZip2InputStream extends InputStream implements BZip2Constants { if (thech >= 0) { bsBuffShadow = (bsBuffShadow << 8) | thech; bsLiveShadow += 8; - continue; } else { throw new IOException("unexpected end of stream"); } @@ -771,7 +770,6 @@ public class CBZip2InputStream extends InputStream implements BZip2Constants { if (thech >= 0) { bsBuffShadow = (bsBuffShadow << 8) | thech; bsLiveShadow += 8; - continue; } else { throw new IOException("unexpected end of stream"); } @@ -786,7 +784,6 @@ public class CBZip2InputStream extends InputStream implements BZip2Constants { if (thech >= 0) { bsBuffShadow = (bsBuffShadow << 8) | thech; bsLiveShadow += 8; - continue; } else { throw new IOException("unexpected end of stream"); } @@ -822,7 +819,6 @@ public class CBZip2InputStream extends InputStream implements BZip2Constants { if (thech >= 0) { bsBuffShadow = (bsBuffShadow << 8) | thech; bsLiveShadow += 8; - continue; } else { throw new IOException("unexpected end of stream"); } http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java b/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java index 01e2342..dd118ea 100644 --- a/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java +++ b/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java @@ -37,36 +37,32 @@ import java.io.OutputStream; * <tt>CBZip2OutputStream</tt> to release the allocated memory. * </p> * - * <p> You can shrink the amount of allocated memory and maybe raise + * <p>You can shrink the amount of allocated memory and maybe raise * the compression speed by choosing a lower blocksize, which in turn * may cause a lower compression ratio. You can avoid unnecessary * memory allocation by avoiding using a blocksize which is bigger - * than the size of the input. </p> + * than the size of the input.</p> * - * <p> You can compute the memory usage for compressing by the - * following formula: </p> + * <p>You can compute the memory usage for compressing by the + * following formula:</p> * * <pre> * <code>400k + (9 * blocksize)</code>. * </pre> * - * <p> To get the memory required for decompression by {@link - * CBZip2InputStream CBZip2InputStream} use </p> + * <p>To get the memory required for decompression by {@link + * CBZip2InputStream CBZip2InputStream} use</p> * * <pre> * <code>65k + (5 * blocksize)</code>. * </pre> * - * <table width="100%" border="1"> - * <colgroup> <col width="33%" /> <col width="33%" /> <col width="33%" /> - * </colgroup> + * <table border="1"> + * <caption>Memory usage by blocksize</caption> * <tr> - * <th colspan="3">Memory usage by blocksize</th> - * </tr> - * <tr> - * <th align="right">Blocksize</th> <th align="right">Compression<br> - * memory usage</th> <th align="right">Decompression<br> - * memory usage</th> + * <th align="right">Blocksize</th> + * <th align="right">Compression<br>memory usage</th> + * <th align="right">Decompression<br>memory usage</th> * </tr> * <tr> * <td align="right">100k</td> @@ -195,10 +191,10 @@ public class CBZip2OutputStream extends OutputStream * This constant is accessible by subclasses for historical * purposes. If you don't know what it means then you don't need * it. - * <p> If you are ever unlucky/improbable enough to get a stack + * <p>If you are ever unlucky/improbable enough to get a stack * overflow whilst sorting, increase the following constant and * try again. In practice I have never seen the stack go above 27 - * elems, so the following limit seems very generous. </p> + * elems, so the following limit seems very generous.</p> */ protected static final int QSORT_STACK_SIZE = 1000; @@ -215,6 +211,11 @@ public class CBZip2OutputStream extends OutputStream * This method is accessible by subclasses for historical * purposes. If you don't know what it does then you don't need * it. + * + * @param len char[] + * @param freq char[] + * @param alphaSize int + * @param maxLen int */ protected static void hbMakeCodeLengths(char[] len, int[] freq, int alphaSize, int maxLen) { @@ -560,14 +561,13 @@ public class CBZip2OutputStream extends OutputStream /** * Chooses a blocksize based on the given length of the data to compress. * + * @param inputLength + * The length of the data which will be compressed by + * <tt>CBZip2OutputStream</tt>. * @return The blocksize, between {@link #MIN_BLOCKSIZE} and * {@link #MAX_BLOCKSIZE} both inclusive. For a negative * <tt>inputLength</tt> this method returns <tt>MAX_BLOCKSIZE</tt> * always. - * - * @param inputLength - * The length of the data which will be compressed by - * <tt>CBZip2OutputStream</tt>. */ public static int chooseBlockSize(long inputLength) { return (inputLength > 0) ? (int) Math @@ -814,7 +814,7 @@ public class CBZip2OutputStream extends OutputStream * is about 2.0e-3 for 32 bits, 1.0e-5 for 40 bits and 4.0e-8 for 48 * bits. For a compressed file of size 100Gb -- about 100000 blocks -- * only a 48-bit marker will do. NB: normal compression/ decompression - * donot rely on these statistical properties. They are only important + * do not rely on these statistical properties. They are only important * when trying to recover blocks from damaged files. */ bsPutUByte(0x31); @@ -854,6 +854,8 @@ public class CBZip2OutputStream extends OutputStream /** * Returns the blocksize parameter specified at construction time. + * + * @return int */ public final int getBlockSize() { return this.blockSize100k; http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/mail/MailMessage.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/mail/MailMessage.java b/src/main/org/apache/tools/mail/MailMessage.java index b4173a9..7287501 100644 --- a/src/main/org/apache/tools/mail/MailMessage.java +++ b/src/main/org/apache/tools/mail/MailMessage.java @@ -44,14 +44,15 @@ import java.util.Vector; * easier to install, and has an Open Source license. * <p> * It can be used like this: - * <blockquote><pre> + * </p> + * <pre> * String mailhost = "localhost"; // or another mail host * String from = "Mail Message Servlet <mailmess...@server.com>"; * String to = "t...@you.com"; * String cc1 = "c...@you.com"; * String cc2 = "c...@you.com"; * String bcc = "b...@you.com"; - * + * * MailMessage msg = new MailMessage(mailhost); * msg.setPort(25); * msg.from(from); @@ -61,16 +62,16 @@ import java.util.Vector; * msg.bcc(bcc); * msg.setSubject("Test subject"); * PrintStream out = msg.getPrintStream(); - * + * * Enumeration enum = req.getParameterNames(); * while (enum.hasMoreElements()) { * String name = (String)enum.nextElement(); * String value = req.getParameter(name); * out.println(name + " = " + value); * } - * + * * msg.sendAndClose(); - * </pre></blockquote> + * </pre> * <p> * Be sure to set the from address, then set the recipient * addresses, then set the subject and other headers, then get the @@ -78,14 +79,17 @@ import java.util.Vector; * The class does minimal error checking internally; it counts on the mail * host to complain if there's any malformatted input or out of order * execution. + * </p> * <p> * An attachment mechanism based on RFC 1521 could be implemented on top of * this class. In the meanwhile, JavaMail is the best solution for sending * email with attachments. + * </p> * <p> * Still to do: + * </p> * <ul> - * <li>Figure out how to close the connection in case of error + * <li>Figure out how to close the connection in case of error</li> * </ul> * * @version 1.1, 2000/03/19, added angle brackets to address, helps some servers http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/mail/SmtpResponseReader.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/mail/SmtpResponseReader.java b/src/main/org/apache/tools/mail/SmtpResponseReader.java index c1693f4..8178a86 100644 --- a/src/main/org/apache/tools/mail/SmtpResponseReader.java +++ b/src/main/org/apache/tools/mail/SmtpResponseReader.java @@ -48,7 +48,7 @@ public class SmtpResponseReader { /** * Read until the server indicates that the response is complete. * - * @return Responsecode (3 digits) + Blank + Text from all + * @return Response code (3 digits) + Blank + Text from all * response line concatenated (with blanks replacing the \r\n * sequences). * @throws IOException on error. @@ -93,7 +93,7 @@ public class SmtpResponseReader { } /** - * Append the text from this line of the resonse. + * Append the text from this line of the response. */ private void append(String line) { // CheckStyle:MagicNumber OFF http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/tar/TarEntry.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/tar/TarEntry.java b/src/main/org/apache/tools/tar/TarEntry.java index 86024ea..fad702f 100644 --- a/src/main/org/apache/tools/tar/TarEntry.java +++ b/src/main/org/apache/tools/tar/TarEntry.java @@ -38,17 +38,19 @@ import org.apache.tools.zip.ZipEncoding; * they are to be used. * <p> * TarEntries that are created from the header bytes read from - * an archive are instantiated with the TarEntry( byte[] ) + * an archive are instantiated with the TarEntry(byte[]) * constructor. These entries will be used when extracting from * or listing the contents of an archive. These entries have their * header filled in using the header bytes. They also set the File * to null, since they reference an archive entry not a file. + * </p> * <p> * TarEntries that are created from Files that are to be written - * into an archive are instantiated with the TarEntry( File ) + * into an archive are instantiated with the TarEntry(File) * constructor. These entries have their header filled in using * the File's information. They also keep a reference to the File * for convenience when writing entries. + * </p> * <p> * Finally, TarEntries can be constructed from nothing but a name. * This allows the programmer to construct the entry by hand, for @@ -56,8 +58,7 @@ import org.apache.tools.zip.ZipEncoding; * the archive, and the header information is constructed from * other information. In this case the header fields are set to * defaults and the File is set to null. - * - * <p> + * </p> * The C structure for a Tar Entry's header is: * <pre> * struct header { @@ -84,8 +85,6 @@ import org.apache.tools.zip.ZipEncoding; * field is the binary representation of the number. * See TarUtils.parseOctalOrBinary. * </pre> - * - * <p> * The C structure for a old GNU Tar Entry's header is: * <pre> * struct oldgnu_header { @@ -108,7 +107,6 @@ import org.apache.tools.zip.ZipEncoding; * char numbytes[12]; // offset 12 * }; * </pre> - * */ public class TarEntry implements TarConstants { @@ -1023,7 +1021,7 @@ public class TarEntry implements TarConstants { /** * Strips Windows' drive letter as well as any leading slashes, - * turns path separators into forward slahes. + * turns path separators into forward slashes. */ private static String normalizeFileName(String fileName, boolean preserveLeadingSlashes) { @@ -1083,10 +1081,10 @@ public class TarEntry implements TarConstants { /** * Check if buffer contents matches Ascii String. * - * @param expected - * @param buffer - * @param offset - * @param length + * @param expected String + * @param buffer byte[] + * @param offset int + * @param length int * @return {@code true} if buffer is the same as the expected string */ private static boolean matchAsciiBuffer(String expected, byte[] buffer, @@ -1105,13 +1103,13 @@ public class TarEntry implements TarConstants { /** * Compare byte buffers, optionally ignoring trailing nulls * - * @param buffer1 - * @param offset1 - * @param length1 - * @param buffer2 - * @param offset2 - * @param length2 - * @param ignoreTrailingNulls + * @param buffer1 byte[] + * @param offset1 int + * @param length1 int + * @param buffer2 byte[] + * @param offset2 int + * @param length2 int + * @param ignoreTrailingNulls boolean * @return {@code true} if buffer1 and buffer2 have same contents, having regard to trailing nulls */ private static boolean isEqual( http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/tar/TarInputStream.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/tar/TarInputStream.java b/src/main/org/apache/tools/tar/TarInputStream.java index 82c0a0d..bacc200 100644 --- a/src/main/org/apache/tools/tar/TarInputStream.java +++ b/src/main/org/apache/tools/tar/TarInputStream.java @@ -62,7 +62,7 @@ public class TarInputStream extends FilterInputStream { /** * This contents of this array is not used at all in this class, - * it is only here to avoid repreated object creation during calls + * it is only here to avoid repeated object creation during calls * to the no-arg read method. */ protected byte[] oneBuf; @@ -541,7 +541,7 @@ public class TarInputStream extends FilterInputStream { /** * Reads a byte from the current tar archive entry. * - * This method simply calls read( byte[], int, int ). + * This method simply calls read(byte[], int, int). * * @return The byte read, or -1 at EOF. * @throws IOException on error @@ -658,6 +658,9 @@ public class TarInputStream extends FilterInputStream { * Whether this class is able to read the given entry. * * <p>May return false if the current entry is a sparse file.</p> + * + * @param te TarEntry + * @return boolean */ public boolean canReadEntryData(TarEntry te) { return !te.isGNUSparse(); http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/tar/TarOutputStream.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/tar/TarOutputStream.java b/src/main/org/apache/tools/tar/TarOutputStream.java index cacc686..f2f0943 100644 --- a/src/main/org/apache/tools/tar/TarOutputStream.java +++ b/src/main/org/apache/tools/tar/TarOutputStream.java @@ -94,6 +94,7 @@ public class TarOutputStream extends FilterOutputStream { /** * Constructor for TarInputStream. + * * @param os the output stream to use */ public TarOutputStream(OutputStream os) { @@ -102,6 +103,7 @@ public class TarOutputStream extends FilterOutputStream { /** * Constructor for TarInputStream. + * * @param os the output stream to use * @param encoding name of the encoding to use for file names */ @@ -111,6 +113,7 @@ public class TarOutputStream extends FilterOutputStream { /** * Constructor for TarInputStream. + * * @param os the output stream to use * @param blockSize the block size to use */ @@ -120,6 +123,7 @@ public class TarOutputStream extends FilterOutputStream { /** * Constructor for TarInputStream. + * * @param os the output stream to use * @param blockSize the block size to use * @param encoding name of the encoding to use for file names @@ -130,6 +134,7 @@ public class TarOutputStream extends FilterOutputStream { /** * Constructor for TarInputStream. + * * @param os the output stream to use * @param blockSize the block size to use * @param recordSize the record size to use @@ -140,6 +145,7 @@ public class TarOutputStream extends FilterOutputStream { /** * Constructor for TarInputStream. + * * @param os the output stream to use * @param blockSize the block size to use * @param recordSize the record size to use @@ -163,6 +169,7 @@ public class TarOutputStream extends FilterOutputStream { * This can be LONGFILE_ERROR(0), LONGFILE_TRUNCATE(1) or LONGFILE_GNU(2). * This specifies the treatment of long file names (names >= TarConstants.NAMELEN). * Default is LONGFILE_ERROR. + * * @param longFileMode the mode to use */ public void setLongFileMode(int longFileMode) { @@ -174,6 +181,7 @@ public class TarOutputStream extends FilterOutputStream { * This can be BIGNUMBER_ERROR(0), BIGNUMBER_POSIX(1) or BIGNUMBER_STAR(2). * This specifies the treatment of big files (sizes > TarConstants.MAXSIZE) and other numeric values to big to fit into a traditional tar header. * Default is BIGNUMBER_ERROR. + * * @param bigNumberMode the mode to use */ public void setBigNumberMode(int bigNumberMode) { @@ -182,6 +190,8 @@ public class TarOutputStream extends FilterOutputStream { /** * Whether to add a PAX extension header for non-ASCII file names. + * + * @param b boolean */ public void setAddPaxHeadersForNonAsciiNames(boolean b) { addPaxHeadersForNonAsciiNames = b; @@ -358,7 +368,7 @@ public class TarOutputStream extends FilterOutputStream { /** * Writes a byte to the current tar archive entry. * - * This method simply calls read( byte[], int, int ). + * This method simply calls read(byte[], int, int). * * @param b The byte written. * @throws IOException on error @@ -373,7 +383,7 @@ public class TarOutputStream extends FilterOutputStream { /** * Writes bytes to the current tar archive entry. * - * This method simply calls write( byte[], int, int ). + * This method simply calls write(byte[], int, int). * * @param wBuf The buffer to write to the archive. * @throws IOException on error http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/tar/TarUtils.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/tar/TarUtils.java b/src/main/org/apache/tools/tar/TarUtils.java index 5fa2e01..70e6a44 100644 --- a/src/main/org/apache/tools/tar/TarUtils.java +++ b/src/main/org/apache/tools/tar/TarUtils.java @@ -280,6 +280,7 @@ public class TarUtils { * @param length The maximum number of bytes to parse. * @param encoding name of the encoding to use for file names * @return The entry name. + * @throws IOException if decode fails */ public static String parseName(final byte[] buffer, final int offset, final int length, @@ -344,6 +345,7 @@ public class TarUtils { * @param length The maximum number of header bytes to copy. * @param encoding name of the encoding to use for file names * @return The updated offset, i.e. offset + length + * @throws IOException if encode fails */ public static int formatNameBytes(final String name, final byte[] buf, final int offset, final int length, http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/zip/AbstractUnicodeExtraField.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/zip/AbstractUnicodeExtraField.java b/src/main/org/apache/tools/zip/AbstractUnicodeExtraField.java index ab56f46..0f236d4 100644 --- a/src/main/org/apache/tools/zip/AbstractUnicodeExtraField.java +++ b/src/main/org/apache/tools/zip/AbstractUnicodeExtraField.java @@ -42,7 +42,7 @@ public abstract class AbstractUnicodeExtraField implements ZipExtraField { * file. * @param off The offset of the encoded filename or comment in * <code>bytes</code>. - * @param len The length of the encoded filename or commentin + * @param len The length of the encoded filename or comment in * <code>bytes</code>. */ protected AbstractUnicodeExtraField(final String text, final byte[] bytes, final int off, http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/zip/AsiExtraField.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/zip/AsiExtraField.java b/src/main/org/apache/tools/zip/AsiExtraField.java index fb8227d..0108ee2 100644 --- a/src/main/org/apache/tools/zip/AsiExtraField.java +++ b/src/main/org/apache/tools/zip/AsiExtraField.java @@ -25,7 +25,7 @@ import java.util.zip.ZipException; * Adds Unix file permission and UID/GID fields as well as symbolic * link handling. * - * <p>This class uses the ASi extra field in the format: + * <p>This class uses the ASi extra field in the format:</p> * <pre> * Value Size Description * ----- ---- ----------- @@ -39,7 +39,7 @@ import java.util.zip.ZipException; * (var.) variable symbolic link filename * </pre> * taken from appnote.iz (Info-ZIP note, 981119) found at <a - * href="ftp://ftp.uu.net/pub/archiving/zip/doc/";>ftp://ftp.uu.net/pub/archiving/zip/doc/</a></p> + * href="ftp://ftp.uu.net/pub/archiving/zip/doc/";>ftp://ftp.uu.net/pub/archiving/zip/doc/</a> * * <p>Short is two bytes and Long is four bytes in big endian byte and http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/zip/ExtraFieldUtils.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/zip/ExtraFieldUtils.java b/src/main/org/apache/tools/zip/ExtraFieldUtils.java index 8a7355e..d7a6c9d 100644 --- a/src/main/org/apache/tools/zip/ExtraFieldUtils.java +++ b/src/main/org/apache/tools/zip/ExtraFieldUtils.java @@ -308,6 +308,8 @@ public class ExtraFieldUtils { /** * Key of the action to take. + * + * @return int */ public int getKey() { return key; } } http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/zip/FallbackZipEncoding.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/zip/FallbackZipEncoding.java b/src/main/org/apache/tools/zip/FallbackZipEncoding.java index 3edbb8e..96cff33 100644 --- a/src/main/org/apache/tools/zip/FallbackZipEncoding.java +++ b/src/main/org/apache/tools/zip/FallbackZipEncoding.java @@ -34,7 +34,7 @@ import java.nio.ByteBuffer; * given name can be safely encoded or not.</p> * * <p>This implementation acts as a last resort implementation, when - * neither {@link Simple8BitZipEnoding} nor {@link NioZipEncoding} is + * neither {@link Simple8BitZipEncoding} nor {@link NioZipEncoding} is * available.</p> * * <p>The methods of this class are reentrant.</p> @@ -61,16 +61,14 @@ class FallbackZipEncoding implements ZipEncoding { } /** - * @see - * org.apache.tools.zip.ZipEncoding#canEncode(java.lang.String) + * @see org.apache.tools.zip.ZipEncoding#canEncode(java.lang.String) */ public boolean canEncode(final String name) { return true; } /** - * @see - * org.apache.tools.zip.ZipEncoding#encode(java.lang.String) + * @see org.apache.tools.zip.ZipEncoding#encode(java.lang.String) */ public ByteBuffer encode(final String name) throws IOException { if (this.charset == null) { // i.e. use default charset, see no-args constructor @@ -81,8 +79,7 @@ class FallbackZipEncoding implements ZipEncoding { } /** - * @see - * org.apache.tools.zip.ZipEncoding#decode(byte[]) + * @see org.apache.tools.zip.ZipEncoding#decode(byte[]) */ public String decode(final byte[] data) throws IOException { if (this.charset == null) { // i.e. use default charset, see no-args constructor http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/zip/GeneralPurposeBit.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/zip/GeneralPurposeBit.java b/src/main/org/apache/tools/zip/GeneralPurposeBit.java index a1af211..3246fbe 100644 --- a/src/main/org/apache/tools/zip/GeneralPurposeBit.java +++ b/src/main/org/apache/tools/zip/GeneralPurposeBit.java @@ -59,6 +59,8 @@ public final class GeneralPurposeBit implements Cloneable { /** * whether the current entry uses UTF8 for file name and comment. + * + * @return boolean */ public boolean usesUTF8ForNames() { return languageEncodingFlag; @@ -66,6 +68,8 @@ public final class GeneralPurposeBit implements Cloneable { /** * whether the current entry will use UTF8 for file name and comment. + * + * @param b boolean */ public void useUTF8ForNames(boolean b) { languageEncodingFlag = b; @@ -74,6 +78,8 @@ public final class GeneralPurposeBit implements Cloneable { /** * whether the current entry uses the data descriptor to store CRC * and size information + * + * @return boolean */ public boolean usesDataDescriptor() { return dataDescriptorFlag; @@ -82,6 +88,8 @@ public final class GeneralPurposeBit implements Cloneable { /** * whether the current entry will use the data descriptor to store * CRC and size information + * + * @param b boolean */ public void useDataDescriptor(boolean b) { dataDescriptorFlag = b; @@ -89,6 +97,8 @@ public final class GeneralPurposeBit implements Cloneable { /** * whether the current entry is encrypted + * + * @return boolean */ public boolean usesEncryption() { return encryptionFlag; @@ -96,6 +106,8 @@ public final class GeneralPurposeBit implements Cloneable { /** * whether the current entry will be encrypted + * + * @param b boolean */ public void useEncryption(boolean b) { encryptionFlag = b; @@ -103,6 +115,8 @@ public final class GeneralPurposeBit implements Cloneable { /** * whether the current entry is encrypted using strong encryption + * + * @return boolean */ public boolean usesStrongEncryption() { return encryptionFlag && strongEncryptionFlag; @@ -110,6 +124,8 @@ public final class GeneralPurposeBit implements Cloneable { /** * whether the current entry will be encrypted using strong encryption + * + * @param b boolean */ public void useStrongEncryption(boolean b) { strongEncryptionFlag = b; @@ -120,6 +136,8 @@ public final class GeneralPurposeBit implements Cloneable { /** * Encodes the set bits in a form suitable for ZIP archives. + * + * @return byte[] */ public byte[] encode() { byte[] result = new byte[2]; @@ -131,7 +149,7 @@ public final class GeneralPurposeBit implements Cloneable { * Encodes the set bits in a form suitable for ZIP archives. * * @param buf the output buffer - * @param offset + * @param offset * The offset within the output buffer of the first byte to be written. * must be non-negative and no larger than <tt>buf.length-2</tt> */ @@ -148,8 +166,10 @@ public final class GeneralPurposeBit implements Cloneable { /** * Parses the supported flags from the given archive data. + * * @param data local file header or a central directory entry. * @param offset offset at which the general purpose bit starts + * @return GeneralPurposeBit */ public static GeneralPurposeBit parse(final byte[] data, final int offset) { final int generalPurposeFlag = ZipShort.getValue(data, offset); http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/zip/NioZipEncoding.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/zip/NioZipEncoding.java b/src/main/org/apache/tools/zip/NioZipEncoding.java index 63d33ff..462b519 100644 --- a/src/main/org/apache/tools/zip/NioZipEncoding.java +++ b/src/main/org/apache/tools/zip/NioZipEncoding.java @@ -51,8 +51,7 @@ class NioZipEncoding implements ZipEncoding { } /** - * @see - * org.apache.tools.zip.ZipEncoding#canEncode(java.lang.String) + * @see org.apache.tools.zip.ZipEncoding#canEncode(java.lang.String) */ public boolean canEncode(final String name) { final CharsetEncoder enc = this.charset.newEncoder(); @@ -63,8 +62,7 @@ class NioZipEncoding implements ZipEncoding { } /** - * @see - * org.apache.tools.zip.ZipEncoding#encode(java.lang.String) + * @see org.apache.tools.zip.ZipEncoding#encode(java.lang.String) */ public ByteBuffer encode(final String name) { final CharsetEncoder enc = this.charset.newEncoder(); @@ -110,8 +108,7 @@ class NioZipEncoding implements ZipEncoding { } /** - * @see - * org.apache.tools.zip.ZipEncoding#decode(byte[]) + * @see org.apache.tools.zip.ZipEncoding#decode(byte[]) */ public String decode(final byte[] data) throws IOException { return this.charset.newDecoder() http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java b/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java index 57a838c..cd40070 100644 --- a/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java +++ b/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java @@ -212,8 +212,7 @@ class Simple8BitZipEncoding implements ZipEncoding { } /** - * @see - * org.apache.tools.zip.ZipEncoding#canEncode(java.lang.String) + * @see org.apache.tools.zip.ZipEncoding#canEncode(java.lang.String) */ public boolean canEncode(final String name) { @@ -230,8 +229,7 @@ class Simple8BitZipEncoding implements ZipEncoding { } /** - * @see - * org.apache.tools.zip.ZipEncoding#encode(java.lang.String) + * @see org.apache.tools.zip.ZipEncoding#encode(java.lang.String) */ public ByteBuffer encode(final String name) { ByteBuffer out = ByteBuffer.allocate(name.length() @@ -257,8 +255,7 @@ class Simple8BitZipEncoding implements ZipEncoding { } /** - * @see - * org.apache.tools.zip.ZipEncoding#decode(byte[]) + * @see org.apache.tools.zip.ZipEncoding#decode(byte[]) */ public String decode(final byte[] data) throws IOException { final char [] ret = new char[data.length]; http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/zip/UnicodeCommentExtraField.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/zip/UnicodeCommentExtraField.java b/src/main/org/apache/tools/zip/UnicodeCommentExtraField.java index 51550fe..ccc51fa 100644 --- a/src/main/org/apache/tools/zip/UnicodeCommentExtraField.java +++ b/src/main/org/apache/tools/zip/UnicodeCommentExtraField.java @@ -24,9 +24,8 @@ package org.apache.tools.zip; * <p>Stores the UTF-8 version of the file comment as stored in the * central directory header.</p> * - * <p>See {@link - * "http://www.pkware.com/documents/casestudies/APPNOTE.TXT PKWARE's - * APPNOTE.TXT, section 4.6.8"}.</p> + * <p>See <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT";>PKWARE's + * APPNOTE.TXT, section 4.6.8</a>.</p> * */ public class UnicodeCommentExtraField extends AbstractUnicodeExtraField { http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/zip/UnicodePathExtraField.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/zip/UnicodePathExtraField.java b/src/main/org/apache/tools/zip/UnicodePathExtraField.java index 8b045a1..7638edd 100644 --- a/src/main/org/apache/tools/zip/UnicodePathExtraField.java +++ b/src/main/org/apache/tools/zip/UnicodePathExtraField.java @@ -24,15 +24,14 @@ package org.apache.tools.zip; * <p>Stores the UTF-8 version of the file name field as stored in the * local header and central directory header.</p> * - * <p>See {@link - * "http://www.pkware.com/documents/casestudies/APPNOTE.TXT PKWARE's - * APPNOTE.TXT, section 4.6.9"}.</p> + * <p>See <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT";>PKWARE's + * APPNOTE.TXT, section 4.6.9</a>.</p> */ public class UnicodePathExtraField extends AbstractUnicodeExtraField { public static final ZipShort UPATH_ID = new ZipShort(0x7075); - public UnicodePathExtraField () { + public UnicodePathExtraField() { } /** http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java b/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java index 92d3002..5c1a8d0 100644 --- a/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java +++ b/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java @@ -22,8 +22,8 @@ package org.apache.tools.zip; * Wrapper for extra field data that doesn't conform to the recommended format of header-tag + size + data. * * <p>The header-id is artificial (and not listed as a known ID in - * {@link <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT";> - * APPNOTE.TXT</a>}). Since it isn't used anywhere except to satisfy the + * <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT";>APPNOTE.TXT</a>). + * Since it isn't used anywhere except to satisfy the * ZipExtraField contract it shouldn't matter anyway.</p> * * @since Ant 1.8.1 http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/zip/UnsupportedZipFeatureException.java ---------------------------------------------------------------------- diff --git a/src/main/org/apache/tools/zip/UnsupportedZipFeatureException.java b/src/main/org/apache/tools/zip/UnsupportedZipFeatureException.java index 291d494..52df40d 100644 --- a/src/main/org/apache/tools/zip/UnsupportedZipFeatureException.java +++ b/src/main/org/apache/tools/zip/UnsupportedZipFeatureException.java @@ -46,6 +46,8 @@ public class UnsupportedZipFeatureException extends ZipException { /** * The unsupported feature that has been used. + * + * @return Feature */ public Feature getFeature() { return reason; @@ -53,6 +55,8 @@ public class UnsupportedZipFeatureException extends ZipException { /** * The entry using the unsupported feature. + * + * @return ZipEntry */ public ZipEntry getEntry() { return entry;
