GMaven (OLD... DO NOT USE)

\n in javadocs cause weirdness

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Won't Fix
  • Affects Version/s: 1.0-beta-3
  • Fix Version/s: 1.0-rc-1
  • Component/s: stub generation
  • Labels:
    None
  • Number of attachments :
    0

Description

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
 */

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Jason Dillon added a comment -

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.

Show
Jason Dillon added a comment - 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.
Hide
Permalink
Luke Daley added a comment -

If you want javadoc generation it's major.

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

Show
Luke Daley added a comment - If you want javadoc generation it's major. Why not just strip all newlines? It will look ugly, but these are only stubs.
Hide
Permalink
Jason Dillon added a comment -

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.

Show
Jason Dillon added a comment - 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.
Hide
Permalink
Luke Daley added a comment -

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

Show
Luke Daley added a comment - Actually, you are write, the java doc look ok. I assumed that they wouldn't. My bad.
Hide
Permalink
Jason Dillon added a comment -

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

Show
Jason Dillon added a comment - re-closing w/won't fix since there was no change

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.