public interface
DocReferenceable
com.parrot.docdown.data.DocReferenceable
Subclasses:
UnknownRefProvider.UnknownApiRef, UnknownRefProvider.UnknownMarkupRef, ExternalRefProvider.ExternalRef, ResourceFile, PackageListPage, MarkupPage, ApiPageRef
Overview
A document that can be referenced
Summary
| Methods | |
|---|---|
| public String | getName() Gets the document name |
| public String | getQualifiedName() Gets the document qualified name |
| public String | getReferenceFrom(Path from) Get the relative path to this document from an other path |
Methods
public String getName()
Gets the document name
Returns:
the document name
public String getQualifiedName()
Gets the document qualified name
Returns:
the document qualified name
Get the relative path to this document from an other path
Parameters:
from: the path from which to get the relative path
Returns:
relative path from the 'from' path