Description Fabrizio Giustina 2004-02-23 14:03:53 EST

The following sample shows 3 problems in javadoc formatting:

public class WrappingTest
{

    /**
     * Javadocs wrapping is wrong when you have a [code] tag just at the end of 
the line like in this situation <code>wrap here</code>.
     */
    public static final String CONSTANT = "somevalue";

    /**
     * Javadocs wrapping is good when you have a [strong] tag just at the end 
of the line like in this situation
     * <strong>wrap here </strong>. (but it always add an addictional 
whitespace before /strong)
     */
    public static final String CONSTANT2 = "somevalue";

    /**
     * Javadocs formatting adds an extra empty line for a [pre] tag like in 
this situation
     * 
     * <pre>wrap here</pre>.
     */
    public static final String CONSTANT3 = "somevalue";

}

1) a <code> tag at the end of the line is not wrapped (totally put on a new 
line) like for other tags. Line length exceed maximum length set (120 chars).

2) wrapping is good for other tags, but an extra whitespace is added before the 
closing tag (<strong>wrap here</strong>. becomes <strong>wrap here </strong>. )

3) an extra newline is appended before a <pre> tag. I think there are no 
configuration options for this like for the "add an empty line before 
parameters", so it should not be added.


Full code formatter preferences used here have been already uploaded for bug 
report 52854