Menu

#19 Listed comments

open
nobody
None
7
2012-07-18
2004-04-23
No

I've some problems with the advice of listed comments.
For example if you change more entities than one, it is
a better seen in the documentation, if it is a list:
@version v2.2 - Changed 1 a larger
of comment
- Changed 2...
- Changed ...n

This is currently documented in the html-files as:
@version v2.2 - Changed 1...
a larger comment
- Changed 2...
- Changed ...n

A change to a table with two columns, one for the
version tag and one for the descripton can solve this
problem. There is also an other idea: The use of html
tags within the documentation.

And again, I like to use dc2d very much and I try to
interest as many people as I know.

Regards

Stefanie

Discussion

  • TridenT

    TridenT - 2004-04-24

    Logged In: YES
    user_id=248829

    I understand the problem.
    I think i will change the table with 2 columns.
    But in this case, I need to change the description of this TAG.
    The revision MUST follow the TAG.

    I have check the JavaDoc reference guide, and you are right!
    I update this request as a "bug tracker", as it is uncompatible
    with JavaDoc.

    ->@version [RevNumber] [AnyText]

    TridenT

    [JavaDoc reference guide]
    The Java Software convention for the argument to the
    @version tag is the SCCS string "%I%, %G%", which converts
    to something like "1.39, 02/28/97" (mm/dd/yy) when the file is
    checked out of SCCS.

     
  • TridenT

    TridenT - 2004-08-10

    Logged In: YES
    user_id=248829

    Will be fixed in next revision (v0.9)

     

Anonymous
Anonymous

Add attachments
Cancel