org.eclipse.cdt.ui
Interface IFunctionSummary.IFunctionPrototypeSummary

All Known Implementing Classes:
FunctionPrototypeSummary
Enclosing interface:
IFunctionSummary

public static interface IFunctionSummary.IFunctionPrototypeSummary


Method Summary
 java.lang.String getArguments()
          Get the arguments of the function.
 java.lang.String getName()
          Get the name of the function.
 java.lang.String getPrototypeString(boolean namefirst)
          Get a nice user defined string.
 java.lang.String getReturnType()
          Get the return type of the function.
 

Method Detail

getName

java.lang.String getName()
Get the name of the function. This should be the same as for IFunctionSummary. ie "int main(int argc, char **argv)" --> "main"

Returns:
The name of the function without any additional information.

getReturnType

java.lang.String getReturnType()
Get the return type of the function. ie "int main(int argc, char **argv)" --> "int"

Returns:
A string containing the return type of the function.

getArguments

java.lang.String getArguments()
Get the arguments of the function. ie "int main(int argc, char **argv)" --> "int argc, char **argv"

Returns:
A string containing the arguments of the function, or null if the function has no arguments.

getPrototypeString

java.lang.String getPrototypeString(boolean namefirst)
Get a nice user defined string. The format of which depends on the variable namefirst namefirst == true: main(int argc, char **argv) int namefirst == false: int main(int argc, char **argv);