Bug 1419 : Wrong display of comments on HTML page
Last modified: 2010-04-12 14:48



Assigned To:

Attachment Type Created Size Actions
Screenshot of wrongly displayed comment image/jpeg 2009-12-26 06:36 77.98 KB

Description:   Opened: 2009-12-26 06:33
Version 1.0.7
Mac OS X Snow Leopard, iMac 2.4GHz Intel Core 2 Duo

When omitting the line breaks in a documentation style comment
/** this is a comment */ the HTML page created when exporting an applet does not display the
comment but the code following that comment. Inserting the line breaks everything works fine.
Not really a problem, but I thought maybe you might wanna know.
Additional Comment #1 From tomdiesel 2009-12-26 06:36
Screenshot of wrongly displayed comment
Additional Comment #2 From fry 2010-02-17 20:26
verified, will look into it.
Additional Comment #3 From brmoon 2010-04-09 01:00
I've modified app/src/processing/app/Sketch.java to ignore single line
comments that have the JavaDoc style comments.

The r6595 code ignores any comments in multiline JavaDoc style comments
that are on the first or last line:

/** this text will be ignored
* this comment will
* be visible in the
* html
* this text will also be ignored */

/** this text will be ignored */

I haven't been able to find anything in the JavaDoc documentation about
this, all their examples seem to have the opening and closing comments on
their own lines.

It would also be possible to include the text that is currently ignored
into the HTML description, or to produce an warning message about ignoring
it. Would you like me to implement either of these, or should I just
upload the patch that fixes the HTML description having code in it.
Additional Comment #4 From fry 2010-04-12 14:48
now fixed for the next release, thanks all.