|
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="cxxDefine"> |
|
8 <title>cxxDefine</title> |
|
9 <shortdesc>The <cxxDefine> element provides the name of the C++ API |
|
10 define, all the elements necessary to describe the members that are introduced |
|
11 by the define declaration.</shortdesc> |
|
12 <refbody> |
|
13 <section> |
|
14 <title>Description</title> |
|
15 <p>The <cxxDefine> element requires |
|
16 an id attribute as an anchor point; this id must always be specified. The |
|
17 id attribute is referenced by the <i>conref</i> attribute and internal applications |
|
18 that refer to the <cxxDefine> element content. The elements <apiName> |
|
19 and <cxxDefineDetail> are required for this top-level container. </p> |
|
20 </section> |
|
21 <example> |
|
22 <title>Example</title> |
|
23 <codeblock><cxxFile id="cfperfmetrics_8cpp"> |
|
24 <apiName>cfperfmetrics.cpp</apiName> |
|
25 <cxxDefine id="cfperfmetrics_8cpp_1aaf45a4d8cdebb244b0f01672cd981fb2"> |
|
26 <apiName>SYMBIAN_ENABLE_NETWORKING_PERFMETRICS</apiName> |
|
27 <cxxDefineDetail> |
|
28 <cxxDefineDefinition> |
|
29 <cxxDefineAccessSpecifier value="public"/> |
|
30 <cxxDefinePrototype>#define SYMBIAN_ENABLE_NETWORKING_PERFMETRICS</cxxDefinePrototype> |
|
31 <cxxDefineNameLookup>SYMBIAN_ENABLE_NETWORKING_PERFMETRICS</cxxDefineNameLookup> |
|
32 <cxxDefineParameters/> |
|
33 <cxxDefineAPIItemLocation> |
|
34 <cxxDefineDeclarationFile name="filePath" value="C:/EPOC/master/sf/os/commsfw/commsfwsupport/commselements/commsfw/src/cfperfmetrics.cpp"/> |
|
35 <cxxDefineDeclarationFileLine name="lineNumber" value="17"/> |
|
36 </cxxDefineAPIItemLocation> |
|
37 </cxxDefineDefinition> |
|
38 <apiDesc/> |
|
39 </cxxDefineDetail> |
|
40 </cxxDefine> |
|
41 <cxxVariable id="cfperfmetrics_8cpp_1a8b57c8f405cbc5de5ad9caf2e1610d0f"> |
|
42 ... |
|
43 </cxxVariable> |
|
44 <cxxEnumeration id="cfperfmetrics_8cpp_1a3a00212a28f7e4e2af6d5d57db53f4d3"> |
|
45 ... |
|
46 </cxxEnumeration> |
|
47 <cxxFileAPIItemLocation> |
|
48 <cxxFileDeclarationFile name="filePath" value="C:/EPOC/master/sf/os/commsfw/commsfwsupport/commselements/commsfw/src/cfperfmetrics.cpp"/> |
|
49 </cxxFileAPIItemLocation> |
|
50 </cxxFile></codeblock> |
|
51 </example> |
|
52 <section conref="../packagedef.dita#cxxDefine-reference/cxxDefine-containedBy-section"/> |
|
53 <section conref="../packagedef.dita#cxxDefine-reference/cxxDefine-contains-section"/> |
|
54 <section conref="../packagedef.dita#cxxDefine-reference/cxxDefine-contentModel-section"/> |
|
55 <section conref="../packagedef.dita#cxxDefine-reference/cxxDefine-attList-section"/> |
|
56 <section conref="../packagedef.dita#cxxDefine-reference/cxxDefine-classValue-section"/> |
|
57 </refbody> |
|
58 </reference> |