cxxFunctionParameter

Describes a function parameter

Description

This element describes a single function parameter-declaration in a parameter-declaration-clause.

See ISO/IEC 14882:2003(E) 8.3.5 Functions [dcl.fct]

Example

Given this code, note parameter name change between declaration and definition:

/**
@param aBuf The buffer, default as 0.
*/
void g(const char* aBuf=0);

void g(const char* aBuffer)
{
	// Implementation
}
            

Then function g would have a cxxFunctionParameter element:

<cxxFunctionParameter>
  <cxxFunctionParameterDeclaredType>const char *</cxxFunctionParameterDeclaredType>
  <cxxFunctionParameterDeclarationName>aBuf</cxxFunctionParameterDeclarationName>
  <cxxFunctionParameterDefinitionName>aBuffer</cxxFunctionParameterDefinitionName>
  <cxxFunctionParameterDefaultValue>0</cxxFunctionParameterDefaultValue>
  <apiDefNote>The buffer, default as 0.</apiDefNote>
</cxxFunctionParameter>
            

Contained by

cxxFunctionParameters

Contains

apiDefNote, cxxFunctionParameterDeclarationName cxxFunctionParameterDeclaredType cxxFunctionParameterDefaultValue cxxFunctionParameterDefinitionName

Content Model

(cxxFunctionParameterDeclaredType then cxxFunctionParameterDeclarationName (optional) then cxxFunctionParameterDefinitionName (optional) then cxxFunctionParameterDefaultValue (optional) then apiDefNote, )

Inheritance

topic/ph reference/ph apiRef/apiDefItem apiOperation/apiDefItem cxxFunction/cxxFunctionParameter