public class CHelpBookImpl extends Object
Modifier and Type | Field and Description |
---|---|
protected Map<String,IFunctionSummary> |
funcName2FuncInfo |
Constructor and Description |
---|
CHelpBookImpl(String pluginId)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
func(String fname,
String desc,
String retType,
String args)
Convenience function for filling in table info
|
int |
getCHelpType() |
IFunctionSummary |
getFunctionInfo(ICHelpInvocationContext context,
String name)
Get available info on the give function by name
|
ICHelpResourceDescriptor[] |
getHelpResources(ICHelpInvocationContext context,
String name)
Get the HelpBook information for the given name (e.g. a function/API)
|
IFunctionSummary[] |
getMatchingFunctions(ICHelpInvocationContext context,
String prefix)
Return a list of functions that begin with the given prefix
|
String |
getTitle() |
protected void |
setTitle(String title) |
public CHelpBookImpl(String pluginId)
pluginId
- public String getTitle()
protected void setTitle(String title)
title
- public int getCHelpType()
public IFunctionSummary getFunctionInfo(ICHelpInvocationContext context, String name)
context
- name
- public IFunctionSummary[] getMatchingFunctions(ICHelpInvocationContext context, String prefix)
context
- prefix
- public ICHelpResourceDescriptor[] getHelpResources(ICHelpInvocationContext context, String name)
context
- name
- Copyright (c) 2011 IBM Corporation and others. All Rights Reserved.