#40 @todo and interfaces

open-accepted
nobody
None
1
2002-04-10
2002-02-20
No

I put a @todo tag on a method in an EJB bean class.

1. The generated remote interface included it in the
javadoc comment on the generated remote interface.
IMO it shouldn't (it's stuff I've got to do in the
bean class, not the remote).

I can't even work around it with the excludedtags
parameter, since that still includes the tags in the
generated code. Perhaps we also need an "ignoredtags"
parameter for ones which should be omitted entirely,
defaulting to "todo"?

2. The overview page and list of packages see that
there's a @todo in my .interfaces package, so include
that package in the various lists. However, if I
click on the package to see its details, there's
nothing listed in there. Presumably this is because
the details pages are only looping through the
classes, despite the interfaces being included when
looping at the package level to do the count.

I see no reason why I shouldn't be able to put @todo's
in my own interface classes, though, so the templates
ought to either include the interfaces as well when
looping through the classes, or have an additional
loop for the package's interfaces.

Discussion

  • Vincent Harcq

    Vincent Harcq - 2002-03-14
    • assigned_to: nobody --> vharcq
    • status: open --> open-fixed
     
  • Vincent Harcq

    Vincent Harcq - 2002-03-14

    Logged In: YES
    user_id=125677

    I have added the exclusion of "excludedtags" into
    method/field comments. It was only working for Class
    comments

     
  • Andy Stevens

    Andy Stevens - 2002-03-22

    Logged In: YES
    user_id=247081

    Still not quite as it should be. The method-level @todo
    tags are now left out of the generated classes (once I
    remembered to add @todo to the excludedtags list), but I
    still get a class-level tag. In fact, that also gets the
    line breaks wrong - I got the following in the remote
    interface:

    /**
    * Remote interface for ReportBatch.
    * @author XDOCLET 1.1.2
    * @todo XDOCLET 1.1.2 * @xdoclet-generated at 22-Mar-02
    13:14:41
    */

    (another class without @todo tags still has author &
    xdoclet-generated on separate lines).

    Secondly, it still ignores interfaces in overview-
    packages.html and classes-list.html

     
  • Vincent Harcq

    Vincent Harcq - 2002-04-10
    • status: open-fixed --> open-accepted
     
  • Vincent Harcq

    Vincent Harcq - 2002-04-10

    Logged In: YES
    user_id=125677

    I fixed the class @todo problem butfor the interfaces we
    need a forAllInterface plus a .gif,...
    I move this as a fetaure request (low priority)

     
  • Vincent Harcq

    Vincent Harcq - 2002-04-10
    • labels: 350999 -->
    • assigned_to: vharcq --> nobody
     
  • Vincent Harcq

    Vincent Harcq - 2002-04-10
    • priority: 5 --> 1
    • summary: Info sub-task and interfaces --> @todo and interfaces
     

Log in to post a comment.