[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

recent javadoc change

From: Eric Blake
Subject: recent javadoc change
Date: Tue, 30 Apr 2002 23:30:39 -0600

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/ (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:
for (int i = 0; i < 10; i++)
 * 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,

This signature intentionally left boring.

Eric Blake             address@hidden
  BYU student, free software programmer

reply via email to

[Prev in Thread] Current Thread [Next in Thread]