Bug 197169

Description Matt McCutchen 2007-07-19 12:36:49 EDT

Build ID: HEAD as of 7/19/2007

I am writing the javadoc comment for an annotation class, and I want to give an example of how to use the annotation.  If I just write it out as-is with the @ sign, both javadoc and JDT think it's a Javadoc tag; javadoc(1) complains that it's unknown and JDT that it's invalid.  Thus, I replaced the @ with @ as suggested by Sun's javadoc(1) man page.  The entity works fine in the generated javadoc and in hovers, but the source formatter expands it back to @, causing the problem again.

I can understand wanting to expand entities as a cleanup, but as a special case, the source formatter needs to be taught never to expand @ in javadoc because that could cause something to be misinterpreted as a javadoc tag.

Steps To Reproduce:
1. Activate the Package Explorer, deselect everything, and paste the following code:

/**
 * Here's an example of how to use this annotation:
 *
 * <pre>
 * &#064;Coolness("extreme") class Foo {}
 * </pre>
 */
public @interface Coolness {
    String value();
}

2. Format the source file that opens (Source -> Format).  A warning appears on the annotation inside the <pre>.