|
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="cxxUnion"> |
|
8 <title>cxxUnion</title> |
|
9 <shortdesc>The <cxxUnion> element provides the name of the C++ API |
|
10 union, all the elements necessary to describe the members that are introduced |
|
11 by the union declaration.</shortdesc> |
|
12 <refbody> |
|
13 <section> |
|
14 <title>Description</title> |
|
15 <p>The <cxxUnion> 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 <cxxUnion> element content. The elements <apiName> |
|
19 and <cxxUnionDetail> are required for this top-level container. </p> |
|
20 </section> |
|
21 <example><title>Example</title> |
|
22 <codeblock><cxxUnion id="union_comms_packer_1_1_t_union"> |
|
23 <apiName>CommsFW::TCFLegacyMessagePacker::TUnion</apiName> |
|
24 <cxxUnionDetail> |
|
25 <cxxUnionDefinition> |
|
26 <cxxUnionAccessSpecifier value="private"/> |
|
27 <cxxUnionAPIItemLocation> |
|
28 <cxxUnionDeclarationFile name="filePath" value="C:/src/include/elements/cftransportmsg.h"/> |
|
29 <cxxUnionDeclarationFileLine name="lineNumber" value="59"/> |
|
30 <cxxUnionDefinitionFile name="filePath" value="C:/src/include/elements/cftransportmsg.h"/> |
|
31 <cxxUnionDefinitionFileLineStart name="lineNumber" value="58"/> |
|
32 <cxxUnionDefinitionFileLineEnd name="lineNumber" value="70"/> |
|
33 </cxxUnionAPIItemLocation> |
|
34 </cxxUnionDefinition> |
|
35 <apiDesc/> |
|
36 </cxxUnionDetail> |
|
37 <cxxUnionNested> |
|
38 <cxxUnionNestedDetail> |
|
39 <cxxUnionNestedStruct href="struct_comms_package.xml#struct_package">CommsFW::TCFLegacyMessagePacker::TUnion::TLegacyPackage</cxxUnionNestedStruct> |
|
40 <cxxUnionNestedStruct href="struct_comms_package.xml#struct_package">CommsFW::TCFLegacyMessagePacker::TUnion::TPackage</cxxUnionNestedStruct> |
|
41 </cxxUnionNestedDetail> |
|
42 </cxxUnionNested> |
|
43 </cxxUnion></codeblock> |
|
44 </example> |
|
45 <section conref="../packagedef.dita#cxxUnion-reference/cxxUnion-containedBy-section"/> |
|
46 <section conref="../packagedef.dita#cxxUnion-reference/cxxUnion-contains-section"/> |
|
47 <section conref="../packagedef.dita#cxxUnion-reference/cxxUnion-contentModel-section"/> |
|
48 <section conref="../packagedef.dita#cxxUnion-reference/cxxUnion-attList-section"/> |
|
49 <section conref="../packagedef.dita#cxxUnion-reference/cxxUnion-classValue-section"/> |
|
50 </refbody> |
|
51 </reference> |