recent javadoc change

[Eric Blake]

I have a complaint about this patch to the Javadoc.  Sun's tools
specifically ignores all leading whitespace up to the first '*' on a
line, so that you can include embedded code while still making it match
the style of the rest of the comment.

        * java/util/AbstractList.java (hashCode):
        Docfix to avoid angle brackets in Javadoc and for pre-formatted
        code without asterisks.

/**
 * In other words, both style 1:
 * <pre>
 * for (int i = 0; i < 10; i++)
 *   System.out.println(i);
 * </pre>
 *
 * and style 2:
<pre>
for (int i = 0; i < 10; i++)
  System.out.println(i);
<pre>
 *
 * should have the same result in the compiled documentation; but I
think style 1 is more consistent.
 */

For more information on Sun's recommendations on doc comment formats,
see
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

-- 
This signature intentionally left boring.

Eric Blake             address@hidden
  BYU student, free software programmer