Interface Documentation<T extends Identity>

Type Parameters:
T - type of identity this documentation belongs to
All Known Implementing Classes:
MockDocumentation

public interface Documentation<T extends Identity>
Interface to collect documentation data for some plug-in element.
Version:
$Id$
  • Method Details

    • getCaption

      String getCaption()
      Returns:
      plug-in element caption or empty string
    • getText

      String getText()
      Returns:
      main documentation text or empty string
    • getReferences

      Returns:
      collection of references in this documentation
    • getDeclaringIdentity

      T getDeclaringIdentity()
      Returns:
      element, for which this documentation is provided