1 <!-- ================================================================= --> |
1 <!-- ================================================================= --> |
2 <!-- HEADER --> |
2 <!-- HEADER --> |
3 <!-- ================================================================= --> |
3 <!-- ================================================================= --> |
4 <!-- MODULE: C++ Union DTD --> |
4 <!-- MODULE: C++ Union DTD --> |
5 <!-- VERSION: 0.5.0 --> |
5 <!-- VERSION: 0.6.0 --> |
6 <!-- DATE: February 2009 --> |
6 <!-- DATE: May 2010 --> |
7 <!-- --> |
7 <!-- --> |
8 <!-- ================================================================= --> |
8 <!-- ================================================================= --> |
9 |
9 |
10 <!-- ================================================================= --> |
10 <!-- ================================================================= --> |
11 <!-- PUBLIC DOCUMENT TYPE DEFINITION --> |
11 <!-- PUBLIC DOCUMENT TYPE DEFINITION --> |
12 <!-- TYPICAL INVOCATION --> |
12 <!-- TYPICAL INVOCATION --> |
13 <!-- --> |
13 <!-- --> |
14 <!-- Refer to this file by the following public identifier or an |
14 <!-- Refer to this file by the following public identifier or an |
15 appropriate system identifier |
15 appropriate system identifier |
16 PUBLIC "-//NOKIA//DTD DITA C++ API Union Reference Type v0.5.0//EN" |
16 PUBLIC "-//NOKIA//DTD DITA C++ API Union Reference Type v0.6.0//EN" |
17 Delivered as file "cxxUnion.dtd" --> |
17 Delivered as file "cxxUnion.dtd" --> |
18 |
18 |
19 <!-- ================================================================= --> |
19 <!-- ================================================================= --> |
20 <!-- SYSTEM: Darwin Information Typing Architecture (DITA) --> |
20 <!-- SYSTEM: Darwin Information Typing Architecture (DITA) --> |
21 <!-- --> |
21 <!-- --> |
22 <!-- PURPOSE: C++ API Reference for Unions --> |
22 <!-- PURPOSE: C++ API Reference for Unions --> |
23 <!-- --> |
23 <!-- --> |
24 <!-- ORIGINAL CREATION DATE: --> |
24 <!-- ORIGINAL CREATION DATE: --> |
25 <!-- November 2009 --> |
25 <!-- November 2009 --> |
26 <!-- --> |
26 <!-- --> |
27 <!-- Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). --> |
27 <!-- Copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies). --> |
28 <!-- All rights reserved. --> |
28 <!-- All rights reserved. --> |
29 <!-- --> |
29 <!-- --> |
30 <!-- Change History (latest at top): --> |
30 <!-- Change History (latest at top): --> |
31 <!-- +++++++++++++++++++++++++++++++ --> |
31 <!-- +++++++++++++++++++++++++++++++ --> |
|
32 <!-- 2010-05-14 PaulRoss: Fixed templates. --> |
32 <!-- 2010-02-16 VOG: Updated. --> |
33 <!-- 2010-02-16 VOG: Updated. --> |
33 <!-- 2010-02-10 PaulRoss: Updated. --> |
34 <!-- 2010-02-10 PaulRoss: Updated. --> |
34 <!-- 2009-11-16 PaulRoss: Initial design. --> |
35 <!-- 2009-11-16 PaulRoss: Initial design. --> |
35 <!-- --> |
36 <!-- --> |
36 <!-- ================================================================= --> |
37 <!-- ================================================================= --> |
37 |
38 |
38 <!-- |
39 <!-- |
39 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
40 Copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies). |
40 All rights reserved. |
41 All rights reserved. |
41 --> |
42 --> |
42 |
43 |
43 <!-- ============ Hooks for domain extension ============ --> |
44 <!-- ============ Hooks for domain extension ============ --> |
44 <!ENTITY % cxxUnion "cxxUnion"> |
45 <!ENTITY % cxxUnion "cxxUnion"> |
48 <!ENTITY % cxxUnionAccessSpecifier "cxxUnionAccessSpecifier"> |
49 <!ENTITY % cxxUnionAccessSpecifier "cxxUnionAccessSpecifier"> |
49 <!-- union has no inheritance |
50 <!-- union has no inheritance |
50 <!ENTITY % cxxUnionDerivations "cxxUnionDerivations"> |
51 <!ENTITY % cxxUnionDerivations "cxxUnionDerivations"> |
51 <!ENTITY % cxxUnionDerivation "cxxUnionDerivation"> |
52 <!ENTITY % cxxUnionDerivation "cxxUnionDerivation"> |
52 --> |
53 --> |
53 <!ENTITY % cxxUnionTemplateParamList "cxxUnionTemplateParamList"> |
54 <!ENTITY % cxxUnionTemplateParameters "cxxUnionTemplateParameters"> |
54 <!ENTITY % cxxUnionTemplateParameter "cxxUnionTemplateParameter"> |
55 <!ENTITY % cxxUnionTemplateParameter "cxxUnionTemplateParameter"> |
55 <!ENTITY % cxxUnionTemplateParamType "cxxUnionTemplateParamType"> |
56 <!ENTITY % cxxUnionTemplateParameterType "cxxUnionTemplateParameterType"> |
56 <!ENTITY % cxxUnionTemplateParamDeclarationName "cxxUnionTemplateParamDeclarationName"> |
|
57 <!ENTITY % cxxUnionTemplateParamDefinitionName "cxxUnionTemplateParamDefinitionName"> |
|
58 |
57 |
59 <!-- Derivation --> |
58 <!-- Derivation --> |
60 <!-- union has no inheritance |
59 <!-- union has no inheritance |
61 <!ENTITY % cxxUnionDerivationAccessSpecifier "cxxUnionDerivationAccessSpecifier"> |
60 <!ENTITY % cxxUnionDerivationAccessSpecifier "cxxUnionDerivationAccessSpecifier"> |
62 <!ENTITY % cxxUnionDerivationVirtual "cxxUnionDerivationVirtual"> |
61 <!ENTITY % cxxUnionDerivationVirtual "cxxUnionDerivationVirtual"> |
147 value CDATA #FIXED "abstract" |
146 value CDATA #FIXED "abstract" |
148 %univ-atts; |
147 %univ-atts; |
149 outputclass CDATA #IMPLIED |
148 outputclass CDATA #IMPLIED |
150 > |
149 > |
151 |
150 |
152 <!-- union has no inheritance |
151 <!-- Templates--> |
153 <!ELEMENT cxxUnionDerivations (%cxxUnionDerivation; | %cxxStructDerivation;)+ > |
152 <!ELEMENT cxxUnionTemplateParameters (%cxxUnionTemplateParameter;)+ > |
154 <!ATTLIST cxxUnionDerivations %univ-atts; |
153 <!ATTLIST cxxUnionTemplateParameters %univ-atts; |
155 outputclass CDATA #IMPLIED |
154 outputclass CDATA #IMPLIED |
156 > |
155 > |
157 |
156 |
158 <!ELEMENT cxxUnionDerivation ( |
157 <!ELEMENT cxxUnionTemplateParameter (%cxxUnionTemplateParameterType;, |
159 %cxxUnionDerivationAccessSpecifier;, |
158 (%apiDefNote;)? |
160 (%cxxUnionDerivationVirtual;)*, |
159 ) |
161 ( |
|
162 %cxxUnionBaseClass; |
|
163 | %cxxUnionBaseStruct; |
|
164 | %cxxUnionBaseUnion; |
|
165 ) |
|
166 ) |
|
167 > |
|
168 <!ATTLIST cxxUnionDerivation %univ-atts; |
|
169 outputclass CDATA #IMPLIED |
|
170 > |
|
171 |
|
172 <!ELEMENT cxxUnionInherits ( |
|
173 %cxxUnionInheritsDetail; |
|
174 ) |
|
175 > |
|
176 |
|
177 <!ATTLIST cxxUnionInherits %univ-atts; |
|
178 outputclass CDATA #IMPLIED |
|
179 domains CDATA "&included-domains;" |
|
180 > |
|
181 |
|
182 <!ELEMENT cxxUnionInheritsDetail ( |
|
183 ( |
|
184 %cxxUnionFunctionInherited; |
|
185 | %cxxUnionVariableInherited; |
|
186 | %cxxUnionEnumerationInherited; |
|
187 | %cxxUnionEnumeratorInherited; |
|
188 )+ |
|
189 ) |
|
190 > |
|
191 |
|
192 <!ATTLIST cxxUnionInheritsDetail %univ-atts; |
|
193 outputclass CDATA #IMPLIED |
|
194 domains CDATA "&included-domains;" |
|
195 > |
|
196 |
|
197 <!ELEMENT cxxUnionFunctionInherited (#PCDATA)*> |
|
198 <!ATTLIST cxxUnionFunctionInherited href CDATA #IMPLIED |
|
199 keyref CDATA #IMPLIED |
|
200 type CDATA #IMPLIED |
|
201 %univ-atts; |
|
202 format CDATA #IMPLIED |
|
203 scope (local | peer | external) #IMPLIED |
|
204 outputclass CDATA #IMPLIED |
|
205 > |
|
206 |
|
207 <!ELEMENT cxxUnionVariableInherited (#PCDATA)*> |
|
208 <!ATTLIST cxxUnionVariableInherited href CDATA #IMPLIED |
|
209 keyref CDATA #IMPLIED |
|
210 type CDATA #IMPLIED |
|
211 %univ-atts; |
|
212 format CDATA #IMPLIED |
|
213 scope (local | peer | external) #IMPLIED |
|
214 outputclass CDATA #IMPLIED |
|
215 > |
|
216 |
|
217 <!ELEMENT cxxUnionEnumerationInherited (#PCDATA)*> |
|
218 <!ATTLIST cxxUnionEnumerationInherited href CDATA #IMPLIED |
|
219 keyref CDATA #IMPLIED |
|
220 type CDATA #IMPLIED |
|
221 %univ-atts; |
|
222 format CDATA #IMPLIED |
|
223 scope (local | peer | external) #IMPLIED |
|
224 outputclass CDATA #IMPLIED |
|
225 > |
|
226 |
|
227 |
|
228 <!ELEMENT cxxUnionDerivationAccessSpecifier EMPTY> |
|
229 <!ATTLIST cxxUnionDerivationAccessSpecifier name CDATA #FIXED "access" |
|
230 value (public | protected | private) "public" |
|
231 %univ-atts; |
|
232 outputclass CDATA #IMPLIED |
|
233 > |
|
234 |
|
235 <!ELEMENT cxxUnionDerivationVirtual EMPTY> |
|
236 <!ATTLIST cxxUnionDerivationVirtual name CDATA #FIXED "virtual" |
|
237 value CDATA #FIXED "true" |
|
238 %univ-atts; |
|
239 outputclass CDATA #IMPLIED |
|
240 > |
|
241 |
|
242 <!ELEMENT cxxUnionBaseClass (#PCDATA)*> |
|
243 <!ATTLIST cxxUnionBaseClass href CDATA #IMPLIED |
|
244 keyref CDATA #IMPLIED |
|
245 type CDATA #IMPLIED |
|
246 %univ-atts; |
|
247 format CDATA #IMPLIED |
|
248 scope (local | peer | external) #IMPLIED |
|
249 outputclass CDATA #IMPLIED |
|
250 > |
|
251 |
|
252 <!ELEMENT cxxUnionBaseStruct (#PCDATA)*> |
|
253 <!ATTLIST cxxUnionBaseStruct href CDATA #IMPLIED |
|
254 keyref CDATA #IMPLIED |
|
255 type CDATA #IMPLIED |
|
256 %univ-atts; |
|
257 format CDATA #IMPLIED |
|
258 scope (local | peer | external) #IMPLIED |
|
259 outputclass CDATA #IMPLIED |
|
260 > |
|
261 |
|
262 <!ELEMENT cxxUnionBaseUnion (#PCDATA)*> |
|
263 <!ATTLIST cxxUnionBaseUnion href CDATA #IMPLIED |
|
264 keyref CDATA #IMPLIED |
|
265 type CDATA #IMPLIED |
|
266 %univ-atts; |
|
267 format CDATA #IMPLIED |
|
268 scope (local | peer | external) #IMPLIED |
|
269 outputclass CDATA #IMPLIED |
|
270 > |
|
271 --> |
|
272 |
|
273 <!ELEMENT cxxUnionTemplateParamList (%cxxUnionTemplateParameter;)+ > |
|
274 <!ATTLIST cxxUnionTemplateParamList %univ-atts; |
|
275 outputclass CDATA #IMPLIED |
|
276 > |
|
277 <!ELEMENT cxxUnionTemplateParameter ( %cxxUnionTemplateParamType;, |
|
278 (%cxxUnionTemplateParamDeclarationName;)?, |
|
279 (%cxxUnionTemplateParamDefinitionName;)? |
|
280 ) |
|
281 > |
160 > |
282 <!ATTLIST cxxUnionTemplateParameter %univ-atts; |
161 <!ATTLIST cxxUnionTemplateParameter %univ-atts; |
283 outputclass CDATA #IMPLIED |
162 outputclass CDATA #IMPLIED |
284 > |
163 > |
285 |
164 |
286 <!ELEMENT cxxUnionTemplateParamType (#PCDATA)*> |
165 <!ELEMENT cxxUnionTemplateParameterType (#PCDATA | %apiRelation;)*> |
287 <!ATTLIST cxxUnionTemplateParamType %univ-atts; |
166 <!ATTLIST cxxUnionTemplateParameterType %univ-atts; |
288 outputclass CDATA #IMPLIED |
167 outputclass CDATA #IMPLIED |
289 > |
168 > |
290 |
169 |
291 <!ELEMENT cxxUnionTemplateParamDeclarationName (#PCDATA)*> |
170 <!-- Location --> |
292 <!ATTLIST cxxUnionTemplateParamDeclarationName %univ-atts; |
|
293 outputclass CDATA #IMPLIED |
|
294 > |
|
295 |
|
296 <!ELEMENT cxxUnionTemplateParamDefinitionName (#PCDATA)*> |
|
297 <!ATTLIST cxxUnionTemplateParamDefinitionName %univ-atts; |
|
298 outputclass CDATA #IMPLIED |
|
299 > |
|
300 <!ELEMENT cxxUnionAPIItemLocation ( |
171 <!ELEMENT cxxUnionAPIItemLocation ( |
301 %cxxUnionDeclarationFile;, |
172 %cxxUnionDeclarationFile;, |
302 %cxxUnionDeclarationFileLine;, |
173 %cxxUnionDeclarationFileLine;, |
303 %cxxUnionDefinitionFile;?, |
174 (%cxxUnionDefinitionFile;)?, |
304 %cxxUnionDefinitionFileLineStart;?, |
175 (%cxxUnionDefinitionFileLineStart;)?, |
305 %cxxUnionDefinitionFileLineEnd;? |
176 (%cxxUnionDefinitionFileLineEnd;)? |
306 ) |
177 ) |
307 > |
178 > |
308 <!ATTLIST cxxUnionAPIItemLocation %univ-atts; |
179 <!ATTLIST cxxUnionAPIItemLocation %univ-atts; |
309 outputclass CDATA #IMPLIED |
180 outputclass CDATA #IMPLIED |
310 > |
181 > |
405 <!ATTLIST cxxUnionAccessSpecifier %global-atts; |
277 <!ATTLIST cxxUnionAccessSpecifier %global-atts; |
406 class CDATA "- topic/state reference/state apiRef/apiQualifier apiClassifier/apiQualifier cxxUnion/cxxUnionAccessSpecifier "> |
278 class CDATA "- topic/state reference/state apiRef/apiQualifier apiClassifier/apiQualifier cxxUnion/cxxUnionAccessSpecifier "> |
407 <!ATTLIST cxxUnionAbstract %global-atts; |
279 <!ATTLIST cxxUnionAbstract %global-atts; |
408 class CDATA "- topic/state reference/state apiRef/apiQualifier apiClassifier/apiQualifier cxxUnion/cxxUnionAbstract "> |
280 class CDATA "- topic/state reference/state apiRef/apiQualifier apiClassifier/apiQualifier cxxUnion/cxxUnionAbstract "> |
409 |
281 |
410 <!-- Representing inheritance --> |
|
411 <!-- union has no inheritance |
|
412 <!ATTLIST cxxUnionDerivations %global-atts; |
|
413 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxUnion/cxxUnionDerivations "> |
|
414 <!ATTLIST cxxUnionDerivation %global-atts; |
|
415 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxUnion/cxxUnionDerivation "> |
|
416 <!ATTLIST cxxUnionDerivationAccessSpecifier %global-atts; |
|
417 class CDATA "- topic/state reference/state apiRef/apiQualifier apiClassifier/apiQualifier cxxUnion/cxxUnionDerivationAccessSpecifier "> |
|
418 <!ATTLIST cxxUnionDerivationVirtual %global-atts; |
|
419 class CDATA "- topic/state reference/state apiRef/apiQualifier apiClassifier/apiQualifier cxxUnion/cxxUnionDerivationVirtual "> |
|
420 <!ATTLIST cxxUnionBaseClass %global-atts; |
|
421 class CDATA "- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier cxxUnion/cxxUnionBaseClass "> |
|
422 <!ATTLIST cxxUnionBaseStruct %global-atts; |
|
423 class CDATA "- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier cxxUnion/cxxUnionBaseStruct "> |
|
424 <!ATTLIST cxxUnionBaseUnion %global-atts; |
|
425 class CDATA "- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier cxxUnion/cxxUnionBaseUnion "> |
|
426 --> |
|
427 |
|
428 <!-- Templates --> |
282 <!-- Templates --> |
429 <!ATTLIST cxxUnionTemplateParamList %global-atts; |
283 <!ATTLIST cxxUnionTemplateParameters %global-atts; |
430 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxUnion/cxxUnionTemplateParamList "> |
284 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxUnion/cxxUnionTemplateParameters "> |
431 <!ATTLIST cxxUnionTemplateParameter %global-atts; |
285 <!ATTLIST cxxUnionTemplateParameter %global-atts; |
432 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxUnion/cxxUnionTemplateParameter "> |
286 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxUnion/cxxUnionTemplateParameter "> |
433 <!ATTLIST cxxUnionTemplateParamType %global-atts; |
287 <!ATTLIST cxxUnionTemplateParameterType %global-atts; |
434 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxUnion/cxxUnionTemplateParamType "> |
288 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxUnion/cxxUnionTemplateParameterType "> |
435 <!ATTLIST cxxUnionTemplateParamDeclarationName %global-atts; |
|
436 class CDATA "- topic/keyword reference/keyword apiRef/apiItemName apiClassifier/apiItemName cxxUnion/cxxUnionTemplateParamDeclarationName "> |
|
437 <!ATTLIST cxxUnionTemplateParamDefinitionName %global-atts; |
|
438 class CDATA "- topic/keyword reference/keyword apiRef/apiItemName apiClassifier/apiItemName cxxUnion/cxxUnionTemplateParamDefinitionName "> |
|
439 |
289 |
440 <!-- Nested records --> |
290 <!-- Nested members --> |
441 <!ATTLIST cxxUnionNested %global-atts; |
291 <!ATTLIST cxxUnionNested %global-atts; |
442 class CDATA "- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier cxxUnion/cxxUnionNested "> |
292 class CDATA "- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier cxxUnion/cxxUnionNested "> |
443 <!ATTLIST cxxUnionNestedDetail %global-atts; |
293 <!ATTLIST cxxUnionNestedDetail %global-atts; |
444 class CDATA "- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiDetail cxxUnion/cxxUnionNestedDetail "> |
294 class CDATA "- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiDetail cxxUnion/cxxUnionNestedDetail "> |
445 <!ATTLIST cxxUnionNestedClass %global-atts; |
295 <!ATTLIST cxxUnionNestedClass %global-atts; |
460 class CDATA "- topic/state reference/state apiRef/apiQualifier apiClassifier/apiQualifier cxxUnion/cxxUnionDefinitionFile "> |
310 class CDATA "- topic/state reference/state apiRef/apiQualifier apiClassifier/apiQualifier cxxUnion/cxxUnionDefinitionFile "> |
461 <!ATTLIST cxxUnionDefinitionFileLineStart %global-atts; |
311 <!ATTLIST cxxUnionDefinitionFileLineStart %global-atts; |
462 class CDATA "- topic/state reference/state apiRef/apiQualifier apiClassifier/apiQualifier cxxUnion/cxxUnionDefinitionFileLineStart "> |
312 class CDATA "- topic/state reference/state apiRef/apiQualifier apiClassifier/apiQualifier cxxUnion/cxxUnionDefinitionFileLineStart "> |
463 <!ATTLIST cxxUnionDefinitionFileLineEnd %global-atts; |
313 <!ATTLIST cxxUnionDefinitionFileLineEnd %global-atts; |
464 class CDATA "- topic/state reference/state apiRef/apiQualifier apiClassifier/apiQualifier cxxUnion/cxxUnionDefinitionFileLineEnd "> |
314 class CDATA "- topic/state reference/state apiRef/apiQualifier apiClassifier/apiQualifier cxxUnion/cxxUnionDefinitionFileLineEnd "> |
465 |
|
466 <!-- union has no inheritance |
|
467 <!ATTLIST cxxUnionInherits %global-atts; |
|
468 class CDATA "- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier cxxUnion/cxxUnionInherits "> |
|
469 <!ATTLIST cxxUnionInheritsDetail %global-atts; |
|
470 class CDATA "- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiDetail cxxUnion/cxxUnionInheritsDetail "> |
|
471 <!ATTLIST cxxUnionEnumerationInherited %global-atts; |
|
472 class CDATA "- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiRelation cxxUnion/cxxUnionEnumerationInherited "> |
|
473 <!ATTLIST cxxUnionFunctionInherited %global-atts; |
|
474 class CDATA "- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiRelation cxxUnion/cxxUnionFunctionInherited "> |
|
475 <!ATTLIST cxxUnionVariableInherited %global-atts; |
|
476 class CDATA "- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiRelation cxxUnion/cxxUnionVariableInherited "> |
|
477 --> |
|