jira.codehaus.org

  • Log In Access more options
    • Online Help
    • Keyboard Shortcuts
    • About JIRA
    • JIRA Credits
    • What?s New
  • Dashboards Access more options (Alt+d)
  • Projects Access more options (Alt+p)
  • Issues Access more options (Alt+i)
  • Maven 1.x Tasklist Plugin
  • MPTASKLIST-11

Non-US-ASCII characters in identifiers hinders todos from being included

  • Log In
  • Views
    • XML
    • Word
    • Printable

Details

  • Type: Bug Bug
  • Status: Open Open
  • Resolution: Unresolved
  • Affects Version/s: None
  • Fix Version/s: None
  • Labels:
    None

Description

If a class has an identifier, say a field, that uses characters other than the ones specified below, the parsing stops there and the rest of the fields will not be included into the DocInfo object. Therefor any todos for those fields will not be included.

The root of this problem is not in the tasklist-plugin itself, but it affects the reports made by it. I have done some digging and found this in the QDox source code:

[A-Za-z_$0-9]* { return Parser.IDENTIFIER; }

Somewhere inside either QDox och vdoclet (@sourceforge) there should be a loop that goes through all the fields in a class. The parser will probably throw a ParseException when it discovers a "bad" field. Now if that exception was caught inside the loop instead of outside the loop, we should at least be able to parse the rest of the fields.

Because of MPTASKLIST-10 I have not been able to verify if this affects methods as well, but my guess is that it does.

Since this is out of scope for this plugin I suggest that we add some user-documentation for this. Just to let them know about this limitation. Perhaps a "Known limitations" section in xdocs/index.xml. I can put together something later on, if you like.

  • Options
    • Sort By Name
    • Sort By Date
    • Ascending
    • Descending
    • Download All

Attachments

  1. Java Source File
    PersonBean.java
    23/Jul/04 7:09 PM
    2 kB
    Dennis Lundberg

Issue Links

is duplicated by

Bug - A problem which impairs or prevents the functions of the product. MPTASKLIST-10 Method todos are never found even if they exist in the code

  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
  • All
  • Comments
  • Work Log
  • History
  • Activity
Hide
Permalink
Dennis Lundberg added a comment - 23/Jul/04 7:09 PM

This is a Java class that can be used to test this issue. When I include this class in a Maven tasklist report I get the following results:

Class Class Todos Method Todos Fields Todos
PersonBean 1 0 1

but the results should be these:

Class Class Todos Method Todos Fields Todos
PersonBean 1 6 3

Ignore the "Method Todos" column here, it has it's own issue MPTASKLIST-10.

Show
Dennis Lundberg added a comment - 23/Jul/04 7:09 PM This is a Java class that can be used to test this issue. When I include this class in a Maven tasklist report I get the following results: Class Class Todos Method Todos Fields Todos PersonBean 1 0 1 but the results should be these: Class Class Todos Method Todos Fields Todos PersonBean 1 6 3 Ignore the "Method Todos" column here, it has it's own issue MPTASKLIST-10.
Hide
Permalink
Carlos Sanchez added a comment - 23/Jul/04 7:28 PM

Could you also report the issues to the projects this plugin rely on?

Show
Carlos Sanchez added a comment - 23/Jul/04 7:28 PM Could you also report the issues to the projects this plugin rely on?
Hide
Permalink
Dennis Lundberg added a comment - 23/Jul/04 7:53 PM

Raised this issue with the developers of vdoclet
http://sourceforge.net/tracker/index.php?func=detail&aid=996903&group_id=47842&atid=451063
and QDox
http://jira.codehaus.org/browse/QDOX-61

Show
Dennis Lundberg added a comment - 23/Jul/04 7:53 PM Raised this issue with the developers of vdoclet http://sourceforge.net/tracker/index.php?func=detail&aid=996903&group_id=47842&atid=451063 and QDox http://jira.codehaus.org/browse/QDOX-61
Hide
Permalink
Mike Williams added a comment - 02/Nov/04 7:01 AM

The underlying bug in QDox (QDOX-61) has now been fixed (in qdox-1.6-SNAPSHOT).

Show
Mike Williams added a comment - 02/Nov/04 7:01 AM The underlying bug in QDox (QDOX-61) has now been fixed (in qdox-1.6-SNAPSHOT).
Hide
Permalink
Dennis Lundberg added a comment - 04/Nov/04 5:53 PM

I have tried the new version of qdox and it solves the problems that this issue descibes. So here a shortlist what needs to be done (IMHO) to resolve and close this issue:

1. Await the final release of qdox 1.6
2. Get qdox-1.6 up on ibiblio
3. Persuade Mike to make a new timestamped build of vdoclet
4. Get that up on ibiblio
5. Patch the project.xml for the maven-vdoclet-plugin to use the new versions
6. Release maven-vdoclet-plugin-1.3
7. Release tasklist-plugin-2.4

Have I missed something?

Show
Dennis Lundberg added a comment - 04/Nov/04 5:53 PM I have tried the new version of qdox and it solves the problems that this issue descibes. So here a shortlist what needs to be done (IMHO) to resolve and close this issue: 1. Await the final release of qdox 1.6 2. Get qdox-1.6 up on ibiblio 3. Persuade Mike to make a new timestamped build of vdoclet 4. Get that up on ibiblio 5. Patch the project.xml for the maven-vdoclet-plugin to use the new versions 6. Release maven-vdoclet-plugin-1.3 7. Release tasklist-plugin-2.4 Have I missed something?

People

  • Assignee:
    Unassigned
    Reporter:
    Dennis Lundberg
Vote (0)
Watch (1)

Dates

  • Created:
    23/Jul/04 6:42 PM
    Updated:
    27/Jan/07 3:39 PM
  • Atlassian JIRA (v5.0.4#731-sha1:3aa7374)
  • Report a problem
  • Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.