Java Reference
In-Depth Information
If the type is specified without its package name, it is resolved as described for
typename . This syntax is ambiguous if the method is overloaded or the class
defines a field by the same name.
typename # methodname ( paramtypes )
A reference to a method or constructor with the type of its parameters explic‐
itly specified. This is useful when cross-referencing an overloaded method. For
example:
@see InputStream # read ( byte [], int , int )
# methodname
A reference to a nonoverloaded method or constructor in the current class or
interface or one of the containing classes, superclasses, or superinterfaces of the
current class or interface. Use this concise form to refer to other methods in the
same class. For example:
@see # setBackgroundColor
# methodname ( paramtypes )
A reference to a method or constructor in the current class or interface or one
of its superclasses or containing classes. This form works with overloaded
methods because it lists the types of the method parameters explicitly. For
example:
@see # setPosition ( int , int )
typename # fieldname
A reference to a named field within the specified class. For example:
@see java . io . BufferedInputStream # buf
If the type is specified without its package name, it is resolved as described for
typename .
# fieldname
A reference to a field in the current type or one of the containing classes, super‐
classes, or superinterfaces of the current type. For example:
@see # x
Doc Comments for Packages
Documentation comments for classes, interfaces, methods, constructors, and fields
appear in Java source code immediately before the definitions of the features they
document. javadoc can also read and display summary documentation for pack‐
ages. Because a package is defined in a directory, not in a single file of source code,
javadoc looks for the package documentation in a file named package.html in the
directory that contains the source code for the classes of the package.
The package.html file should contain simple HTML documentation for the package.
It can also contain @see , @link , @deprecated , and @since tags. Because
Search WWH ::




Custom Search