[#MGROOVY-107] \n in javadocs cause weirdness

GMaven

\n in javadocs cause weirdness

Created: 17/Dec/07 11:34 PM Updated: 20/Jan/08 08:50 PM

Component/s:

stub generation

Affects Version/s:

1.0-beta-3

Fix Version/s:

1.0-rc-1

Time Tracking:

Not Specified

Description

« Hide

Newlines in the comment section don't get written out properly.

In groovy ....

/**
 * Line 1.
 * Line 2.
 * 
 * @param blah A variable
 */

In the generated java stub ...

/**
 * Line 1.
Line 2.
 * 
 * @param blah A variable
 */

All

Comments

Work Log

Change History

Sort Order:

Ascending order - Click to sort in descending order

[ Permlink | « Hide ]

Jason Dillon - 19/Jan/08 02:15 PM

Is this really a major issue? Does this cause the site javadocs to mess up? I'm not sure what to do about this really.

[ Permlink | « Hide ]

Luke Daley - 20/Jan/08 05:13 PM

If you want javadoc generation it's major.

Why not just strip all newlines? It will look ugly, but these are only stubs.

[ Permlink | « Hide ]

Jason Dillon - 20/Jan/08 05:24 PM

Does it actually have a negative affect on the generated html docs? What its doing now is inspecting each line in the comment and stripping out the {} bits, then giving QDox the multi-line string... which it then tries to re-{}.

Can you give me a screen shot of what the html docs look like? If they are okay, then I don't care... but if they are whack, then I'll try harder to find a fix.

[ Permlink | « Hide ]

Luke Daley - 20/Jan/08 05:59 PM

Actually, you are write, the java doc look ok. I assumed that they wouldn't. My bad.

[ Permlink | « Hide ]

Jason Dillon - 20/Jan/08 08:50 PM

re-closing w/won't fix since there was no change