QDox

Taglets without content at end of JavaDoc comment

Details

  • Type: Bug Bug
  • Status: Resolved Resolved
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 1.10.1
  • Fix Version/s: 1.11
  • Component/s: Parser
  • Labels:
    None
  • Number of attachments :
    0

Description

On parsing a Source-File with any JavaDoc containing a Taglet without content before the closing comment QDox will throw a parser error

syntax error @[x, y]

This has been verified with JavaDoc comments on class, field and method level.

Example code:

/**
 * Example Code QDox 1.10.1 can not parse
 * @anytaglet*/
public class TestQDoxBug {

	/** @anytaglet*/
	int a;

	/** @anytaglet*/
	void m() { /* void */ }
}

A few things to note:

  • I'm perfectly aware this is very bad style (especially when the original author had done this with a @deprecated taglet ), but I had to deal with this problem in existing code and it took me quite some time to figure out, since QDox seems to always get the line-numbers somewhat too high on this one (looks like it's always signaling the error is on the start of the NEXT JavaDoc block)
  • The problem is still around in the current snapshot version (from 2010-01-10)

Regards,
Sam Bernet

PS: Keep up the nice work!

Activity

Hide
Robert Scholte added a comment -

Fix in rev. 701

Show
Robert Scholte added a comment - Fix in rev. 701

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: