Package org.eclipse.ease.ui.help.hovers
Class ModuleHelp
java.lang.Object
org.eclipse.ease.ui.help.hovers.ModuleHelp
- All Implemented Interfaces:
IHoverHelp
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.eclipse.ease.ui.help.hovers.IHoverHelp
IHoverHelp.IMementoVisitor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetConstantHelp
(Field field) getMethodHelp
(Method method) static URL
getModuleHelpLocation
(ModuleDefinition definition) Retrieve help page URL for a given module definition.getName()
-
Constructor Details
-
ModuleHelp
Help provider for modules, methods and fields.- Parameters:
helpLocation
- location of help html file.- Throws:
Exception
- when help content cannot be read
-
-
Method Details
-
getModuleHelpLocation
Retrieve help page URL for a given module definition.- Parameters:
definition
- module definition to get location for- Returns:
- help URL
-
getName
- Specified by:
getName
in interfaceIHoverHelp
-
getDescription
- Specified by:
getDescription
in interfaceIHoverHelp
-
getDeprecationMessage
-
getHoverContent
- Specified by:
getHoverContent
in interfaceIHoverHelp
-
getConstantHelp
-
getMethodHelp
- Throws:
Exception
-