org.eclipse.cdt.ui
Interface IFunctionSummary


public interface IFunctionSummary


Nested Class Summary
static interface IFunctionSummary.IFunctionPrototypeSummary
           
 
Method Summary
 java.lang.String getDescription()
          Gets the description of the function.
 IRequiredInclude[] getIncludes()
          Get headers required by this function
 java.lang.String getName()
          Gets the name of the function.
 java.lang.String getNamespace()
          Get the full namespace qualifier for this function (generally C++ only)
 IFunctionSummary.IFunctionPrototypeSummary getPrototype()
          Gets the prototype description for this function.
 

Method Detail

getName

java.lang.String getName()
Gets the name of the function. This is the simple name without any additional return or argument information. The function "int main(int argc, char **argv)" would return "main"

Returns:
The name of the function without any additional information

getNamespace

java.lang.String getNamespace()
Get the full namespace qualifier for this function (generally C++ only)

Returns:
The string of the fully qualified namespace for this function, or null if the namespace is not known.

getDescription

java.lang.String getDescription()
Gets the description of the function. This string can be either text or HTML coded and is displayed as part of the hover help and as the context proposal information.

Returns:
A description for this function, or null if no description is available.

getPrototype

IFunctionSummary.IFunctionPrototypeSummary getPrototype()
Gets the prototype description for this function.

Returns:
The IFunctionPrototypeSummary describing the prototype for this function

getIncludes

IRequiredInclude[] getIncludes()
Get headers required by this function

Returns:
A list of IRequiredInclude definitions, or null if no include definitions are available.