You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@beehive.apache.org by Steve Hanson <st...@bea.com> on 2004/08/30 20:14:18 UTC

Javadoc bug in JDK5.0

Hi all:

Please avoid the following syntax in the first sentences of your Javadoc comments:

	{@link #...}

This syntax breaks the javadoc build in the current JDK5 beta (b59).  The folks at Sun say this bug will ship unfixed in the general release of JDK5.

The bug goes like this:

If the first sentence of your Javadoc comment contains an inline {@link} tag and that tag's first argument begins with the hash character #, then javadoc will fail with a ClassCastException.

Here is an example of the bad syntax:

	This is the first sentence of my Javadoc comment {@link #myMethod}.

But the following syntax is ok:
	
 	This is the first sentence of my Javadoc comment {@link myClass#myMethod}.

I will try to fix all of the JAVA source files today.

Thanks, 
Steve Hanson