[Cdk-devel] [ cdk-Project Maintainance Tasks-898131 ] Complete @author tags

[SourceForge.net <no...@so...>]

Project Maintainance Tasks item #898131, was opened at 2004-02-16 17:24
Message generated for change (Comment added) made by egonw
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=631143&aid=898131&group_id=20024

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
Status: Open
>Resolution: Accepted
>Priority: 7
Submitted By: Egon Willighagen (egonw)
Assigned to: Nobody/Anonymous (nobody)
Summary: Complete @author tags

Initial Comment:
Add @author tags to all classes that don't have this 
yet, and unify the syntax of the author names (or sf 
account, or name, or name+email etc). 

----------------------------------------------------------------------

>Comment By: Egon Willighagen (egonw)
Date: 2006-09-18 17:07

Message:
Logged In: YES 
user_id=25678

Additionally, the copyright notices should state the 
original author, instead of "The CDK project". @author 
should be given for everyone who considerable contributed 
to the code.

----------------------------------------------------------------------

Comment By: NathanaMazuir (mlemaudit)
Date: 2004-02-16 20:23

Message:
Logged In: YES 
user_id=935018

Just some questions I'm asking myself...

Q: Who's name should appear in the Javadoc coments ?
Is it the name of the original author, or the name of each 
person that was involved in the class' developpement ?

Q: Where should @author tags should be found ? Only in the 
class JavaDoc comments or in all possible places (i.e. in 
method, field or constructor JavaDoc comments) ?

I suppose that the class maintainer's name may appear in the 
JavaDoc comment in the first place (if there are more than 
one author) and with an e mail link to provide easy feedback 
information. I'm thinking about something like this:

@author <a href="mailto:use...@us...?
cc=cdk...@li...&subject=Feedback%20
[pakage name][class name]">User Name</a>

Of course, this special author name should only appear once 
per class.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=631143&aid=898131&group_id=20024