cxxFunctionParameters

Element that contains information about the function parameter-declaration-clause.

Description

This element that contains information about the function parameter-declaration-clause that describes any function parameters.

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

Example

Given this code:

/*!
 Copies bytes from a source memory area to a destination memory area,
 where both areas may not overlap.
 @param dest The memory area to copy to.
 @param src  The memory area to copy from.
 @param n    The number of bytes to copy
 */
void memcpy(void *dest, const void *src, size_t n); 
            

Then function memcpy would have the cxxFunctionParameters element:

<cxxFunctionParameters>
  <cxxFunctionParameter>
    <cxxFunctionParameterDeclaredType>void *</cxxFunctionParameterDeclaredType>
    <cxxFunctionParameterDeclarationName>dest</cxxFunctionParameterDeclarationName>
    <apiDefNote>The memory area to copy to. </apiDefNote>
  </cxxFunctionParameter>
  <cxxFunctionParameter>
    <cxxFunctionParameterDeclaredType>const void *</cxxFunctionParameterDeclaredType>
    <cxxFunctionParameterDeclarationName>src</cxxFunctionParameterDeclarationName>
    <apiDefNote>The memory area to copy from. </apiDefNote>
  </cxxFunctionParameter>
  <cxxFunctionParameter>
    <cxxFunctionParameterDeclaredType>size_t</cxxFunctionParameterDeclaredType>
    <cxxFunctionParameterDeclarationName>n</cxxFunctionParameterDeclarationName>
    <apiDefNote>The number of bytes to copy </apiDefNote>
  </cxxFunctionParameter>
</cxxFunctionParameters>
            

Contained by

cxxFunctionDefinition

Contains

cxxFunctionParameter

Content Model

cxxFunctionParameter (any number)

Inheritance

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