|
1 <?xml version="1.0" encoding="UTF-8"?> |
|
2 <!-- |
|
3 Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). |
|
4 All rights reserved. |
|
5 --> |
|
6 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> |
|
7 <reference xml:lang="en-us" outputclass="element" id="cxxFunctionParameters"> |
|
8 <title>cxxFunctionParameters</title> |
|
9 <shortdesc>Element that contains information about the function <i>parameter-declaration-clause</i>.</shortdesc> |
|
10 <refbody> |
|
11 <section id="section_ECD16DFA14C4446D832BFA86259E7F46"> |
|
12 <title>Description</title><p>This element that contains information about the function <i>parameter-declaration-clause</i> that describes any function parameters. |
|
13 </p><p>See ISO/IEC 14882:2003(E) 8.3.5 Functions [dcl.fct]</p> |
|
14 </section> |
|
15 <example id="example_5010C29323334FAABBF69B680B70A5A5"> |
|
16 <title>Example</title><p>Given this code:</p> |
|
17 <codeblock>/*! |
|
18 Copies bytes from a source memory area to a destination memory area, |
|
19 where both areas may not overlap. |
|
20 @param dest The memory area to copy to. |
|
21 @param src The memory area to copy from. |
|
22 @param n The number of bytes to copy |
|
23 */ |
|
24 void memcpy(void *dest, const void *src, size_t n); |
|
25 </codeblock><p>Then function <tt>memcpy</tt> would have the <tt>cxxFunctionParameters</tt> |
|
26 element:</p> |
|
27 <codeblock><cxxFunctionParameters> |
|
28 <cxxFunctionParameter> |
|
29 <cxxFunctionParameterDeclaredType>void *</cxxFunctionParameterDeclaredType> |
|
30 <cxxFunctionParameterDeclarationName>dest</cxxFunctionParameterDeclarationName> |
|
31 <apiDefNote>The memory area to copy to. </apiDefNote> |
|
32 </cxxFunctionParameter> |
|
33 <cxxFunctionParameter> |
|
34 <cxxFunctionParameterDeclaredType>const void *</cxxFunctionParameterDeclaredType> |
|
35 <cxxFunctionParameterDeclarationName>src</cxxFunctionParameterDeclarationName> |
|
36 <apiDefNote>The memory area to copy from. </apiDefNote> |
|
37 </cxxFunctionParameter> |
|
38 <cxxFunctionParameter> |
|
39 <cxxFunctionParameterDeclaredType>size_t</cxxFunctionParameterDeclaredType> |
|
40 <cxxFunctionParameterDeclarationName>n</cxxFunctionParameterDeclarationName> |
|
41 <apiDefNote>The number of bytes to copy </apiDefNote> |
|
42 </cxxFunctionParameter> |
|
43 </cxxFunctionParameters> |
|
44 </codeblock> |
|
45 </example> |
|
46 <section conref="../packagedef.dita#cxxFunctionParameters-reference/cxxFunctionParameters-containedBy-section"/> |
|
47 <section conref="../packagedef.dita#cxxFunctionParameters-reference/cxxFunctionParameters-contains-section"/> |
|
48 <section conref="../packagedef.dita#cxxFunctionParameters-reference/cxxFunctionParameters-contentModel-section"/> |
|
49 <section conref="../packagedef.dita#cxxFunctionParameters-reference/cxxFunctionParameters-attList-section"/> |
|
50 <section conref="../packagedef.dita#cxxFunctionParameters-reference/cxxFunctionParameters-classValue-section"/> |
|
51 </refbody> |
|
52 </reference> |