Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#4 Update Copyright statements in headers

open
nobody
None
7
2012-10-08
2004-02-16
Egon Willighagen
No

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).

Discussion

  • 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 [pakage name][class name]">User Name

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

     
  • 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.