[news.eclipse.tools] Re: JavaDoc niggles

["Carolyn MacLeod" <Carolyn_MacLeod@xxxxxxx>]

I agree with your interpretation, and I have opened this PR to address the
problem:
1GIVGMH: ITPJUI:ALL - EC: Javadoc hoverhelp incorrectly uses first of
multiple comments
Carolyn

"Jon Skeet" <skeet@xxxxxxxxx> wrote in message
news:MPG.15edf0e799709b5998969a@xxxxxxxxxxxxxxxxxxx
> Carolyn MacLeod <Carolyn_MacLeod@xxxxxxx> wrote:
>
> <snip actions - thanks :) >
>
> > For #3, I don't think having multiple Javadoc comments for a class is
legal
> > Javadoc, but I don't see anything that explicitly says that on Sun's
> > "Writing Javadoc Comments" web page:
> > http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
>
> http://java.sun.com/products/jdk/1.2/docs/tooldocs/solaris/javadoc.html#
> documentationcomments
>
> has a few pointers, but they're not exactly explicit:
>
> <quote>
> Placement of comments - Documentation comments are recognized only when
> placed immediately before class, interface, constructor, method, or
> field declarations -- see the class example, method example, and field
> example. Documentation comments placed in the body of a method are
> ignored. Only one documentation comment per declaration statement is
> recognized by the Javadoc tool.
> </quote>
>
> I would interpret that to mean that only the JavaDoc comment
> *immediately* before the method/class/field/whatever should be taken.
> (That's what the Sun javadoc tool happens to do, but of course that's
> not to say it's specified at all.)
>
> --
> Jon Skeet - <skeet@xxxxxxxxx>
> http://www.pobox.com/~skeet/
> If replying to the group, please do not mail me too