com.sun.tools.doclets.doccheck
Class DocCheck.ICheck

java.lang.Object
  |
  +--com.sun.tools.doclets.doccheck.DocCheck.ICheck

Enclosing class:

DocCheck

public class DocCheck.ICheck

extends java.lang.Object

Inner class that checks to see if a method is implemented by an interface the class declares or inherits. The list of interfaces the class implements is built by the constructor so that it only occurs once.

Method Summary

java.lang.String

implementsInterface(com.sun.javadoc.MethodDoc md) Checks to see if the method implements an interface.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

implementsInterface

public java.lang.String implementsInterface(com.sun.javadoc.MethodDoc md)

Checks to see if the method implements an interface. If so, the Standard doclet inherits the comment from that interface.

Note:
The ClassDoc.interfaces() method returns only the interfaces declared by a class, not those it inherits.

Parameters:

md - a MethodDoc object

Returns:

a String containing the fully qualified name of the interface, or null