ese-unibe-ch/ese2011-team3 — comment on commit b43ceca19e9ff8d003dbae80d57a0b76a9d6053b
File: calendar/app/models/User.java line 63
By poljpocket:

sorry, but that's wrong. It's actually the user with name 'nickname' and password 'password'. If such user exists, it's returned and if not, 'null' is returned.

This is how I would write the JavaDoc for this method:

/**
* Returns the user which matches the give username and password combination.
* If such user exists, it's returned and if not, 'null' is returned.
* Use this method to authenticate an user who tries to log in.
* Reject authentication if 'null' is returned here.
*
* @param nickname the nickname of the given name/pwd combination
* @param password the password of the given name/pwd combination
* @return the apropriate User object if name/pwd combination exists, 'null' if not
*/

Consider this as an example of how to write JavaDoc. You see, that the method's detailed description and purpose is contained. What's important is, that special cases as the "returns null if such user doesn't exist" are discussed. You please now just adapt this to all the other methods. Remember: Also the class head (where you just wrote @author Alt-F4) needs JavaDoc. Explain what the class' purpose is and where it's located in the application (here: the model).

Thanks, Julian