Merge pull request #108 from antville/fix-javadoc-warnings

Fix JavaDoc warnings

src/main/java/helma/framework/ResponseBean.java

@@ -280,9 +280,9 @@ public class ResponseBean implements Serializable {
     }
 
     /**
-     * add an HTML formatted debug message to the end of the page.
+     * add HTML formatted debug messages to the end of the page.
      *
-     * @param message the message
+     * @param messages the list of messages
      */
     public void debug(String... messages) {
         if (messages == null) {

src/main/java/helma/framework/ResponseTrans.java

@@ -384,7 +384,7 @@ public final class ResponseTrans extends Writer implements Serializable {
     }
 
     /**
-     * Replace special characters with entities, including <, > and ", thus allowing
+     * Replace special characters with entities, including {@code <}, {@code >} and {@code "}, thus allowing
      * no HTML tags.
      */
     public synchronized void encode(Object what) {
@@ -415,7 +415,7 @@ public final class ResponseTrans extends Writer implements Serializable {
     }
 
     /**
-     * Replace special characters with entities, including <, > and ", thus allowing
+     * Replace special characters with entities, including {@code <}, {@code >} and {@code "}, thus allowing
      * no HTML tags.
      */
     public synchronized void encodeXml(Object what) {

src/main/java/helma/image/ImageWrapper.java

@@ -514,7 +514,7 @@ public class ImageWrapper {
     /**
      * Reduces the colors used in the image. Necessary before saving as GIF.
      *
-     * @param colors colors the number of colors to use, usually <= 256.
+     * @param colors colors the number of colors to use, usually {@literal <}= 256.
      */
     public void reduceColors(int colors) {
         reduceColors(colors, false);
@@ -523,7 +523,7 @@ public class ImageWrapper {
     /**
      * Reduces the colors used in the image. Necessary before saving as GIF.
      *
-     * @param colors colors the number of colors to use, usually <= 256.
+     * @param colors colors the number of colors to use, usually {@literal <}= 256.
      * @param dither ...
      */
     public void reduceColors(int colors, boolean dither) {
@@ -534,7 +534,7 @@ public class ImageWrapper {
      * Reduce the colors used in this image. Useful and necessary before saving
      * the image as GIF file.
      *
-     * @param colors the number of colors to use, usually <= 256.
+     * @param colors the number of colors to use, usually {@literal <}= 256.
      * @param dither ...
      * @param alphaToBitmask ...
      */

src/main/java/helma/servlet/AbstractServletClient.java

@@ -753,7 +753,7 @@ public abstract class AbstractServletClient extends HttpServlet {
      * <strong>IMPLEMENTATION NOTE</strong>:  URL decoding is performed
      * individually on the parsed name and value elements, rather than on
      * the entire query string ahead of time, to properly deal with the case
-     * where the name or value includes an encoded "=" or "&" character
+     * where the name or value includes an encoded {@code =} or {@code &} character
      * that would otherwise be interpreted as a delimiter.
      *
      * NOTE: byte array data is modified by this method.  Caller beware.

src/main/java/helma/util/HtmlEncoder.java

@@ -127,7 +127,7 @@ public final class HtmlEncoder {
     /**
      *  Do "smart" encodging on a string. This means that valid HTML entities and tags,
      *  Helma macros and HTML comments are passed through unescaped, while
-     *  other occurrences of '<', '>' and '&' are encoded to HTML entities.
+     *  other occurrences of {@code <}, {@code >} and {@code &} are encoded to HTML entities.
      */
     public final static String encode(String str) {
         if (str == null) {
@@ -151,7 +151,7 @@ public final class HtmlEncoder {
     /**
      *  Do "smart" encodging on a string. This means that valid HTML entities and tags,
      *  Helma macros and HTML comments are passed through unescaped, while
-     *  other occurrences of '<', '>' and '&' are encoded to HTML entities.
+     *  other occurrences of {@code <}, {@code >} and {@code &} are encoded to HTML entities.
      */
     public final static void encode(String str, StringBuffer ret) {
         encode(str, ret, false, null);
@@ -160,7 +160,7 @@ public final class HtmlEncoder {
     /**
      *  Do "smart" encodging on a string. This means that valid HTML entities and tags,
      *  Helma macros and HTML comments are passed through unescaped, while
-     *  other occurrences of '<', '>' and '&' are encoded to HTML entities.
+     *  other occurrences of {@code <}, {@code >} and {@code &} are encoded to HTML entities.
      *
      *  @param str the string to encode
      *  @param ret the string buffer to encode to