Describes a function parameter
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]
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>
apiDefNote, cxxFunctionParameterDeclarationName cxxFunctionParameterDeclaredType cxxFunctionParameterDefaultValue cxxFunctionParameterDefinitionName
(cxxFunctionParameterDeclaredType then cxxFunctionParameterDeclarationName (optional) then cxxFunctionParameterDefinitionName (optional) then cxxFunctionParameterDefaultValue (optional) then apiDefNote, )