|
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="cxxFunction"> |
|
8 <title>cxxFunction</title> |
|
9 <shortdesc>Contains all the elements needed to describe the declaration of a C++ function (or <i>member</i> function).</shortdesc> |
|
10 <refbody> |
|
11 <section id="section_B20A7D521E3842829C774491FDD670A5"> |
|
12 <title>Description</title><p>The <tt><cxxFunction></tt> element requires |
|
13 an ID attribute as an anchor point; this ID must always be specified. The |
|
14 ID attribute is referenced by the <i>conref</i> attribute from internal applications |
|
15 that refer to the <tt><cxxFunctiion></tt> element content. The elements <tt><apiName></tt> |
|
16 and <tt><cxxFunctionDetail></tt> are required for this top-level container. |
|
17 </p><p> |
|
18 <?xm-replace_text Paragraph ?> |
|
19 </p> |
|
20 </section> |
|
21 <example id="example_F38D1539002D4528B2FBC2B42EB2AECA"> |
|
22 <title>Example</title><p>The following illustrates a typical (global) function:</p> |
|
23 <codeblock><cxxFunction id="test__class_8h_1a27a789a5aabed6e0e0d79ce0fd02b937"> |
|
24 <apiName>SearchBuffer</apiName> |
|
25 <cxxFunctionDetail> |
|
26 <cxxFunctionDefinition> |
|
27 <cxxFunctionAccessSpecifier value="public"/> |
|
28 <cxxFunctionStorageClassSpecifierStatic/> |
|
29 <cxxFunctionDeclaredType>int</cxxFunctionDeclaredType> |
|
30 <cxxFunctionScopedName/> |
|
31 <cxxFunctionPrototype>static int SearchBuffer(const char *aBuffer, char c, int i)</cxxFunctionPrototype> |
|
32 <cxxFunctionNameLookup>SearchBuffer(const char *,char,int)</cxxFunctionNameLookup> |
|
33 <cxxFunctionParameters> |
|
34 <cxxFunctionParameter> |
|
35 <cxxFunctionParameterDeclaredType>const char *</cxxFunctionParameterDeclaredType> |
|
36 <cxxFunctionParameterDeclarationName>aBuffer</cxxFunctionParameterDeclarationName> |
|
37 <apiDefNote>The buffer to search. </apiDefNote> |
|
38 </cxxFunctionParameter> |
|
39 <cxxFunctionParameter> |
|
40 <cxxFunctionParameterDeclaredType>char</cxxFunctionParameterDeclaredType> |
|
41 <cxxFunctionParameterDeclarationName>c</cxxFunctionParameterDeclarationName> |
|
42 <apiDefNote>the character to search for. </apiDefNote> |
|
43 </cxxFunctionParameter> |
|
44 <cxxFunctionParameter> |
|
45 <cxxFunctionParameterDeclaredType>int</cxxFunctionParameterDeclaredType> |
|
46 <cxxFunctionParameterDeclarationName>i</cxxFunctionParameterDeclarationName> |
|
47 <apiDefNote>The start position. </apiDefNote> |
|
48 </cxxFunctionParameter> |
|
49 </cxxFunctionParameters> |
|
50 <apiDefNote>The index in the buffer or -1 if not found or i is &gt;= the buffer length. </apiDefNote> |
|
51 <cxxFunctionAPIItemLocation> |
|
52 <cxxFunctionDeclarationFile name="filePath" value="C:/wip/sysdoc/tools/Doxygen/branches/DITA/test/PaulRo/cxxApiExamples/src/test_class.h"/> |
|
53 <cxxFunctionDeclarationFileLine name="lineNumber" value="14"/> |
|
54 </cxxFunctionAPIItemLocation> |
|
55 </cxxFunctionDefinition> |
|
56 <apiDesc> |
|
57 <p>Searches a buffer for a character from a start position in the buffer. </p> |
|
58 </apiDesc> |
|
59 </cxxFunctionDetail> |
|
60 </cxxFunction> |
|
61 </codeblock> |
|
62 </example> |
|
63 <section conref="../packagedef.dita#cxxFunction-reference/cxxFunction-containedBy-section"/> |
|
64 <section conref="../packagedef.dita#cxxFunction-reference/cxxFunction-contains-section"/> |
|
65 <section conref="../packagedef.dita#cxxFunction-reference/cxxFunction-contentModel-section"/> |
|
66 <section conref="../packagedef.dita#cxxFunction-reference/cxxFunction-attList-section"/> |
|
67 <section conref="../packagedef.dita#cxxFunction-reference/cxxFunction-classValue-section"/> |
|
68 </refbody> |
|
69 </reference> |