org.eclipse.xtext.documentation

Interface IEObjectDocumentationProvider

All Known Implementing Classes:

MultiLineCommentDocumentationProvider

public interface IEObjectDocumentationProvider

Returns a documentation string for an EObject. There exists an extension interface for the documentation provider:

• IEObjectDocumentationProviderExtension allows to query the nodes that yield the documentation

Author:

Christoph Kulla - Initial contribution and API

Method Summary

Methods

Modifier and Type	Method and Description
String	getDocumentation(org.eclipse.emf.ecore.EObject o) returns the documentation or null if no documentation is attached to the given EObject.

Method Detail

getDocumentation

String getDocumentation(org.eclipse.emf.ecore.EObject o)

returns the documentation or null if no documentation is attached to the given EObject.