JPF 0.10

org.java.plugin.registry
Interface Documentation


public interface Documentation

Interface to collect documentation data for some plug-in element.

Version:
$Id: Documentation.java,v 1.1 2005/07/20 18:43:46 ddimon Exp $

Nested Class Summary
static interface Documentation.Reference
          Documentation reference.
 
Method Summary
 java.lang.String getCaption()
           
 Identity getDeclaringIdentity()
           
 java.util.Collection getReferences()
           
 java.lang.String getText()
           
 

Method Detail

getCaption

public java.lang.String getCaption()
Returns:
plug-in element caption or empty string

getText

public java.lang.String getText()
Returns:
main documentation text or empty string

getReferences

public java.util.Collection getReferences()
Returns:
collection of references in this documentation

getDeclaringIdentity

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

JPF 0.10

Copyright © 2004-2005 Dmitry Olshansky. All Rights Reserved.