|
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="cxxStruct"> |
|
8 <title>cxxStruct</title> |
|
9 <shortdesc>The <cxxStruct> element provides the name of the C++ API |
|
10 struct, all the elements necessary to describe the members that are introduced |
|
11 by the struct declaration, and the members inherited from the direct base struct.</shortdesc> |
|
12 <refbody> |
|
13 <section> |
|
14 <title>Description</title> |
|
15 <p>The <cxxStruct> 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 <cxxStruct> element content. The elements <apiName> |
|
19 and <cxxStructDetail> are required for this top-level container. </p> |
|
20 </section> |
|
21 <example> |
|
22 <title>Example</title> |
|
23 <codeblock><cxxClass id="GUID-697DBFB2-9EB6-3C22-BB12-92FDF3A03DF4"> |
|
24 <apiName>CSocketServer</apiName> |
|
25 <cxxClassDetail> |
|
26 <cxxClassDefinition> |
|
27 <cxxClassAccessSpecifier value="public" /> |
|
28 <cxxClassAPIItemLocation> |
|
29 <cxxClassDeclarationFile name="filePath" value="s:/sf/os/commsfw/datacommsserver/esockserver/inc/ss_std.h" /> |
|
30 <cxxClassDeclarationFileLine name="lineNumber" value="309" /> |
|
31 </cxxClassAPIItemLocation> |
|
32 </cxxClassDefinition> |
|
33 <apiDesc /> |
|
34 </cxxClassDetail> |
|
35 </cxxClass> |
|
36 </codeblock> |
|
37 </example> |
|
38 <section conref="../packagedef.dita#cxxStruct-reference/cxxStruct-containedBy-section"/> |
|
39 <section conref="../packagedef.dita#cxxStruct-reference/cxxStruct-contains-section"/> |
|
40 <section conref="../packagedef.dita#cxxStruct-reference/cxxStruct-contentModel-section"/> |
|
41 <section conref="../packagedef.dita#cxxStruct-reference/cxxStruct-attList-section"/> |
|
42 <section conref="../packagedef.dita#cxxStruct-reference/cxxStruct-classValue-section"/> |
|
43 </refbody> |
|
44 </reference> |