author | Jonathan Harrington <jonathan.harrington@nokia.com> |
Wed, 11 Aug 2010 14:49:30 +0100 | |
changeset 4 | 468f4c8d3d5b |
permissions | -rw-r--r-- |
4
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
1 |
<?xml version="1.0" encoding="UTF-8"?> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
2 |
<!-- |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
3 |
Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
4 |
All rights reserved. |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
5 |
--> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
6 |
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
7 |
<reference xml:lang="en-us" outputclass="element" id="cxxFunction"> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
8 |
<title>cxxFunction</title> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
9 |
<shortdesc>Contains all the elements needed to describe the declaration of a C++ function (or <i>member</i> function).</shortdesc> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
10 |
<refbody> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
11 |
<section id="section_B20A7D521E3842829C774491FDD670A5"> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
12 |
<title>Description</title><p>The <tt><cxxFunction></tt> element requires |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
13 |
an ID attribute as an anchor point; this ID must always be specified. The |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
14 |
ID attribute is referenced by the <i>conref</i> attribute from internal applications |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
15 |
that refer to the <tt><cxxFunctiion></tt> element content. The elements <tt><apiName></tt> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
16 |
and <tt><cxxFunctionDetail></tt> are required for this top-level container. |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
17 |
</p><p> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
18 |
<?xm-replace_text Paragraph ?> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
19 |
</p> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
20 |
</section> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
21 |
<example id="example_F38D1539002D4528B2FBC2B42EB2AECA"> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
22 |
<title>Example</title><p>The following illustrates a typical (global) function:</p> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
23 |
<codeblock><cxxFunction id="test__class_8h_1a27a789a5aabed6e0e0d79ce0fd02b937"> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
24 |
<apiName>SearchBuffer</apiName> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
25 |
<cxxFunctionDetail> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
26 |
<cxxFunctionDefinition> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
27 |
<cxxFunctionAccessSpecifier value="public"/> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
28 |
<cxxFunctionStorageClassSpecifierStatic/> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
29 |
<cxxFunctionDeclaredType>int</cxxFunctionDeclaredType> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
30 |
<cxxFunctionScopedName/> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
31 |
<cxxFunctionPrototype>static int SearchBuffer(const char *aBuffer, char c, int i)</cxxFunctionPrototype> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
32 |
<cxxFunctionNameLookup>SearchBuffer(const char *,char,int)</cxxFunctionNameLookup> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
33 |
<cxxFunctionParameters> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
34 |
<cxxFunctionParameter> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
35 |
<cxxFunctionParameterDeclaredType>const char *</cxxFunctionParameterDeclaredType> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
36 |
<cxxFunctionParameterDeclarationName>aBuffer</cxxFunctionParameterDeclarationName> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
37 |
<apiDefNote>The buffer to search. </apiDefNote> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
38 |
</cxxFunctionParameter> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
39 |
<cxxFunctionParameter> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
40 |
<cxxFunctionParameterDeclaredType>char</cxxFunctionParameterDeclaredType> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
41 |
<cxxFunctionParameterDeclarationName>c</cxxFunctionParameterDeclarationName> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
42 |
<apiDefNote>the character to search for. </apiDefNote> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
43 |
</cxxFunctionParameter> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
44 |
<cxxFunctionParameter> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
45 |
<cxxFunctionParameterDeclaredType>int</cxxFunctionParameterDeclaredType> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
46 |
<cxxFunctionParameterDeclarationName>i</cxxFunctionParameterDeclarationName> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
47 |
<apiDefNote>The start position. </apiDefNote> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
48 |
</cxxFunctionParameter> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
49 |
</cxxFunctionParameters> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
50 |
<apiDefNote>The index in the buffer or -1 if not found or i is &gt;= the buffer length. </apiDefNote> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
51 |
<cxxFunctionAPIItemLocation> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
52 |
<cxxFunctionDeclarationFile name="filePath" value="C:/wip/sysdoc/tools/Doxygen/branches/DITA/test/PaulRo/cxxApiExamples/src/test_class.h"/> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
53 |
<cxxFunctionDeclarationFileLine name="lineNumber" value="14"/> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
54 |
</cxxFunctionAPIItemLocation> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
55 |
</cxxFunctionDefinition> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
56 |
<apiDesc> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
57 |
<p>Searches a buffer for a character from a start position in the buffer. </p> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
58 |
</apiDesc> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
59 |
</cxxFunctionDetail> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
60 |
</cxxFunction> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
61 |
</codeblock> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
62 |
</example> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
63 |
<section conref="../packagedef.dita#cxxFunction-reference/cxxFunction-containedBy-section"/> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
64 |
<section conref="../packagedef.dita#cxxFunction-reference/cxxFunction-contains-section"/> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
65 |
<section conref="../packagedef.dita#cxxFunction-reference/cxxFunction-contentModel-section"/> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
66 |
<section conref="../packagedef.dita#cxxFunction-reference/cxxFunction-attList-section"/> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
67 |
<section conref="../packagedef.dita#cxxFunction-reference/cxxFunction-classValue-section"/> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
68 |
</refbody> |
468f4c8d3d5b
Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff
changeset
|
69 |
</reference> |