org.eclipse.ptp.pldt.common.editorHelp

Class FunctionSummaryImpl

java.lang.Object

org.eclipse.ptp.pldt.common.editorHelp.FunctionSummaryImpl

public class FunctionSummaryImpl
extends Object

Used by all four PLDT types MPI, OpenMP, LAPI and UPC, to create the structures that hover help needs

Constructor Summary

Constructors

Constructor and Description
FunctionSummaryImpl()
FunctionSummaryImpl(String name, String namespace, String description, IFunctionPrototypeSummary prototype, IRequiredInclude[] includes) Function information used in editor help

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
IRequiredInclude[]	getIncludes()
String	getName()
String	getNamespace()
IFunctionPrototypeSummary	getPrototype()
void	setDescription(String description) Set description of this function
void	setIncludes(IRequiredInclude[] includes) Set the list of required includes for this function
void	setName(String name) Set the name of this function
void	setNamespace(String namespace) Set namespace
void	setPrototype(IFunctionPrototypeSummary prototype) Set Function prototype summary information for this object
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FunctionSummaryImpl

public FunctionSummaryImpl()

FunctionSummaryImpl

public FunctionSummaryImpl(String name,
                   String namespace,
                   String description,
                   IFunctionPrototypeSummary prototype,
                   IRequiredInclude[] includes)

Function information used in editor help

Parameters:

name - - used for the name of the html help file referenced by the F1 (dynamic help) function key. Other use too? assumed.

namespace -

description -

prototype -

includes -

Method Detail

getName

public String getName()

getNamespace

public String getNamespace()

getDescription

public String getDescription()

getPrototype

public IFunctionPrototypeSummary getPrototype()

getIncludes

public IRequiredInclude[] getIncludes()

setDescription

public void setDescription(String description)

Set description of this function

Parameters:

description -

setIncludes

public void setIncludes(IRequiredInclude[] includes)

Set the list of required includes for this function

Parameters:

includes -

setName

public void setName(String name)

Set the name of this function

Parameters:

name -

setNamespace

public void setNamespace(String namespace)

Set namespace

Parameters:

namespace -

setPrototype

public void setPrototype(IFunctionPrototypeSummary prototype)

Set Function prototype summary information for this object

Parameters:

prototype -

toString

public String toString()

Overrides:

toString in class Object