Package org.java.plugin.registry

Interface Documentable<T extends Identity>

Type Parameters:
T - type of identity to be documented
All Known Subinterfaces:
Extension, Extension.Parameter, ExtensionPoint, ExtensionPoint.ParameterDefinition, Library, PluginAttribute, PluginDescriptor, PluginElement<T>, PluginFragment, PluginPrerequisite
All Known Implementing Classes:
MockExtension, MockExtensionPoint, MockLibrary, MockParameter, MockParameterDefinition, MockPluginAttribute, MockPluginDescriptor, MockPluginElement, MockPluginFragment, MockPluginPrerequisite
public interface Documentable<T extends Identity>
Interface to get access to plug-in element documentation.
Version:
$Id$

  • Method Details

    • getDocumentation

      Documentation<T> getDocumentation()
      Returns:
      plug-in element documentation object or null if there is no documentation provided

    • getDocsPath

      String getDocsPath()
      Returns:
      path to documentation "home", it is used for resolving documentation references