QDox

Parsing of named parameters in JavaDoc does not like spaces

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 1.4
  • Fix Version/s: 1.5
  • Component/s: None
  • Labels:
    None
  • Number of attachments :
    0

Description

Using the latest 1.4 snapshot:

The method that parses a Javadoc tag up into named parameters uses a StringTokenizer to do the work. This causes an unnatural formatting restriction on the developers part.

@hibernate.class table = "Users"

The extra space around the '=' character causes the tokenizer to see three individual parameters for this tag instead of one. It sees no named parameters.

I don't believe named parameters are part of the Javadoc spec, but they are used a lot; particularly in nearly every XDoclet subtask. XDoclet does not consider whitespace around the equals sign to be a factor when determining named parameters.

Activity

Hide
Mike Williams added a comment -

Aslak, we should probably maintain compat with xjavadoc, right? Can you easily sync up the name-parameter parsing code?

Show
Mike Williams added a comment - Aslak, we should probably maintain compat with xjavadoc, right? Can you easily sync up the name-parameter parsing code?
Hide
Aslak Hellesoy added a comment -

I think we should support this, but I don't see it as critical so it's postponed to 1.5.

Show
Aslak Hellesoy added a comment - I think we should support this, but I don't see it as critical so it's postponed to 1.5.
Hide
Mike Williams added a comment -

I've re-written the tag-parameter parsing using StreamTokenizer rather than StringTokenizer. It should now be compatible with XDoclet/XJavadoc.

Show
Mike Williams added a comment - I've re-written the tag-parameter parsing using StreamTokenizer rather than StringTokenizer. It should now be compatible with XDoclet/XJavadoc.
Hide
Mike Williams added a comment -

Closed, in consultation with Jim.

Show
Mike Williams added a comment - Closed, in consultation with Jim.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: