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:
- AnnotatedExtension, AnnotatedParameter, ExtensionPointImpl, ExtensionPointImpl.ParameterDefinitionImpl
public interface Documentable<T extends Identity>
Interface to get access to plug-in element documentation.
- Version:
- $Id$
getDocumentation
Documentation<T> getDocumentation()
- Returns:
- plug-in element documentation object or
null
if there is no documentation provided
getDocsPath
java.lang.String getDocsPath()
- Returns:
- path to documentation "home", it is used for resolving
documentation references
Copyright © 2010. All Rights Reserved.