|
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="cxxEnumeration"> |
|
8 <title>cxxEnumeration</title> |
|
9 <shortdesc>The <cxxEnumeration> element contains all the elements needed to describe the declaration of a C++ enumeration.</shortdesc> |
|
10 <refbody> |
|
11 <section> |
|
12 <title>Description</title> |
|
13 <p>The <cxxEnumeration> element requires |
|
14 an <i>id</i> attribute as an anchor point; id must always be specified. The |
|
15 id attribute is referenced by the <i>conref</i> attribute from internal applications |
|
16 that refer to the <cxxFunctiion> element content. The elements <apiName> |
|
17 and <cxxEnumerationDetail> are required for this top-level container. </p> |
|
18 </section> |
|
19 <example> |
|
20 <title>Example</title> |
|
21 <codeblock><cxxEnumeration id="class_b_trace_1a289a8c50777f50be7f2d0535670c1e8d"> |
|
22 <apiName>THeaderStructure</apiName> |
|
23 <cxxEnumerationDetail> |
|
24 <cxxEnumerationDefinition> |
|
25 <cxxEnumerationAccessSpecifier value="public"/> |
|
26 <cxxEnumerationScopedName>BTrace</cxxEnumerationScopedName> |
|
27 <cxxEnumerationPrototype>THeaderStructure</cxxEnumerationPrototype> |
|
28 <cxxEnumerationNameLookup>BTrace:THeaderStructure</cxxEnumerationNameLookup> |
|
29 <cxxEnumerators> |
|
30 <cxxEnumerator id="class_b_trace_1a289a8c50777f50be7f2d0535670c1e8daacb3d2fc73e5d51e0cfe218fe61a4a64"> |
|
31 <apiName>ESizeIndex</apiName> |
|
32 <cxxEnumeratorScopedName>BTrace</cxxEnumeratorScopedName> |
|
33 <cxxEnumeratorPrototype>ESizeIndex = 0</cxxEnumeratorPrototype> |
|
34 <cxxEnumeratorNameLookup>BTrace::ESizeIndex</cxxEnumeratorNameLookup> |
|
35 <cxxEnumeratorInitialiser value="0"/> |
|
36 <cxxEnumeratorAPIItemLocation> |
|
37 <cxxEnumeratorDeclarationFile name="filePath" value="C:/src/include/e32btrace.h"/> |
|
38 <cxxEnumeratorDeclarationFileLine name="lineNumber" value="177"/> |
|
39 </cxxEnumeratorAPIItemLocation> |
|
40 <apiDesc> |
|
41 <p>Size of record in bytes. </p> |
|
42 </apiDesc> |
|
43 </cxxEnumerator> |
|
44 <cxxEnumerator id="class_b_trace_1a289a8c50777f50be7f2d0535670c1e8da88aa2174423cbfd0a14b6bc857e06745"> |
|
45 <apiName>EFlagsIndex</apiName> |
|
46 <cxxEnumeratorScopedName>BTrace</cxxEnumeratorScopedName> |
|
47 <cxxEnumeratorPrototype>EFlagsIndex = 1</cxxEnumeratorPrototype> |
|
48 <cxxEnumeratorNameLookup>BTrace::EFlagsIndex</cxxEnumeratorNameLookup> |
|
49 <cxxEnumeratorInitialiser value="1"/> |
|
50 <cxxEnumeratorAPIItemLocation> |
|
51 <cxxEnumeratorDeclarationFile name="filePath" value="C:/src/include/e32btrace.h"/> |
|
52 <cxxEnumeratorDeclarationFileLine name="lineNumber" value="190"/> |
|
53 </cxxEnumeratorAPIItemLocation> |
|
54 <apiDesc> |
|
55 <p>Bitfield of flags from enum TFlags. E.g. to detect if a timestamp is present in the record, code like this could be used. <codeblock> TUint8* record; // pointer to trace record |
|
56 if(record[BTrace::EFlagsIndex]&BTrace::ETimestampPresent) |
|
57 TimestampPresent(); |
|
58 else |
|
59 TimestampNotPresent();</codeblock> </p> |
|
60 </apiDesc> |
|
61 </cxxEnumerator> |
|
62 </cxxEnumerators> |
|
63 <cxxEnumerationAPIItemLocation> |
|
64 <cxxEnumerationDeclarationFile name="filePath" value="C:/src/include/e32btrace.h"/> |
|
65 <cxxEnumerationDeclarationFileLine name="lineNumber" value="173"/> |
|
66 <cxxEnumerationDefinitionFile name="filePath" value="C:/EPOC/master/sf/os/commsfw/serialserver/c32serialserver/CCOMM/CC_CLI.CPP"/> |
|
67 <cxxEnumerationDefinitionFileLineStart name="lineNumber" value="172"/> |
|
68 <cxxEnumerationDefinitionFileLineEnd name="lineNumber" value="201"/> |
|
69 </cxxEnumerationAPIItemLocation> |
|
70 </cxxEnumerationDefinition> |
|
71 <apiDesc> |
|
72 <p>Byte indices into the trace header for specific fields. </p> |
|
73 </apiDesc> |
|
74 </cxxEnumerationDetail> |
|
75 </cxxEnumeration></codeblock> |
|
76 </example> |
|
77 <section conref="../packagedef.dita#cxxEnumeration-reference/cxxEnumeration-containedBy-section"/> |
|
78 <section conref="../packagedef.dita#cxxEnumeration-reference/cxxEnumeration-contains-section"/> |
|
79 <section conref="../packagedef.dita#cxxEnumeration-reference/cxxEnumeration-contentModel-section"/> |
|
80 <section conref="../packagedef.dita#cxxEnumeration-reference/cxxEnumeration-attList-section"/> |
|
81 <section conref="../packagedef.dita#cxxEnumeration-reference/cxxEnumeration-classValue-section"/> |
|
82 </refbody> |
|
83 </reference> |