diff -r d8fccb2cd802 -r 468f4c8d3d5b DITA-OT_CXX_Plugin/cxxapiref/doc/cxxFunction/cxxFunctionParameter.dita --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/DITA-OT_CXX_Plugin/cxxapiref/doc/cxxFunction/cxxFunctionParameter.dita Wed Aug 11 14:49:30 2010 +0100 @@ -0,0 +1,42 @@ + + + + + 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> + + +
+
+
+
+
+ +