public interface
IRefProvider
com.parrot.docdown.data.IRefProvider
Subclasses:
UnknownRefProvider, RefProvider, RefLocator, LocalRefProvider, ExternalRefProvider
Overview
Interface defining a provider of DocReferenceable
Summary
| Methods | |
|---|---|
| public DocReferenceable | getClassDocRef(com.sun.javadoc.ClassDoc classDoc) Gets a reference to a class. |
| public DocReferenceable | getExecutableMemberDocRef(com.sun.javadoc.ExecutableMemberDoc executableMemberDoc) Gets a reference to a executable member. |
| public DocReferenceable | getFieldDocRef(com.sun.javadoc.FieldDoc fieldDoc) Gets a reference to a field. |
| public DocReferenceable | getMarkupDocRef(MarkupDoc markupDoc) Gets a reference to a markup document. |
| public DocReferenceable | getPackageDocRef(com.sun.javadoc.PackageDoc packageDoc) Gets a reference to a package. |
| public DocReferenceable | getResourceFileRef(ResourceDoc resourceDoc) Gets a reference to a markup document. |
Methods
public DocReferenceable getPackageDocRef(com.sun.javadoc.PackageDoc packageDoc)
Gets a reference to a package.
Parameters:
packageDoc: javadoc package doc
Returns:
a DocReferenceable, null if not found
public DocReferenceable getClassDocRef(com.sun.javadoc.ClassDoc classDoc)
Gets a reference to a class.
Parameters:
classDoc: javadoc class doc
Returns:
a DocReferenceable, null if not found
public DocReferenceable getFieldDocRef(com.sun.javadoc.FieldDoc fieldDoc)
Gets a reference to a field.
Parameters:
fieldDoc: javadoc field doc
Returns:
a DocReferenceable, null if not found
public DocReferenceable getExecutableMemberDocRef(com.sun.javadoc.ExecutableMemberDoc executableMemberDoc)
Gets a reference to a executable member.
Parameters:
executableMemberDoc: javadoc executable member doc
Returns:
a DocReferenceable, null if not found
Gets a reference to a markup document.
Parameters:
markupDoc: markup doc
Returns:
a DocReferenceable, null if not found
Gets a reference to a markup document.
Parameters:
resourceDoc: resource doc
Returns:
a DocReferenceable, null if not found