Generating Javadoc

Javadoc is a utility to document Java code in HTML format. The Javadoc documentation is generated from comments and tags added to Java classes or methods. The comments start with the /** string and end with */. Inside these comments, tags can be added. The following tags, in the same order as they should be added, are available in Javadoc:

• @author: This indicates the author or authors of the code.

• @version: This indicates the version of the class or method. Used for classes and interfaces.

• @param: This describes a method parameter. Only used in methods and constructors.

• @return: This describes the return object of a method. Only used in methods that do not return void.

• @throws: This describes an exception that can be thrown by the method. Equivalent to @exception.

• @see: This indicates a reference, which can be an URL, another element in the documentation, or just some text.

• @serial: This indicates if a field is serializable.

• @deprecated: This indicates that a method is...