You can use the following tags in your Javadoc comments. These get picked up by the tool to serve as the text for your documentation.
@author Who wrote this class. Use this only with classes and interfaces, not methods. Use separate @author tags for each author if there's more than one.
@version Identifies the version of the class. Use only with classes and interfaces. Use the following values:
/** * @author eben.hewitt * @version 1.0 */
@param Indicates a parameter to a method or a type parameter to a class. Use a separate @param tag for each parameter. For use in methods and constructors only. Don't include the param's type, just its name and description, as in the following:
/** for method: * @param salary The boss's current ...