1 <!-- ================================================================= --> |
1 <!-- ================================================================= --> |
2 <!-- HEADER --> |
2 <!-- HEADER --> |
3 <!-- ================================================================= --> |
3 <!-- ================================================================= --> |
4 <!-- MODULE: C++ Class DTD --> |
4 <!-- MODULE: C++ Class 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 Class Reference Type v0.5.0//EN" |
16 PUBLIC "-//NOKIA//DTD DITA C++ API Class Reference Type v0.6.0//EN" |
17 Delivered as file "cxxClass.dtd" --> |
17 Delivered as file "cxxClass.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 Classes --> |
22 <!-- PURPOSE: C++ API Reference for Classes --> |
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 % cxxClass "cxxClass"> |
45 <!ENTITY % cxxClass "cxxClass"> |
51 <!ENTITY % cxxClassDerivations "cxxClassDerivations"> |
52 <!ENTITY % cxxClassDerivations "cxxClassDerivations"> |
52 <!ENTITY % cxxClassDerivation "cxxClassDerivation"> |
53 <!ENTITY % cxxClassDerivation "cxxClassDerivation"> |
53 <!ENTITY % cxxStructDerivation "cxxStructDerivation"> |
54 <!ENTITY % cxxStructDerivation "cxxStructDerivation"> |
54 |
55 |
55 <!-- Templates --> |
56 <!-- Templates --> |
56 <!ENTITY % cxxClassTemplateParamList "cxxClassTemplateParamList"> |
57 <!ENTITY % cxxClassTemplateParameters "cxxClassTemplateParameters"> |
57 <!ENTITY % cxxClassTemplateParameter "cxxClassTemplateParameter"> |
58 <!ENTITY % cxxClassTemplateParameter "cxxClassTemplateParameter"> |
58 <!ENTITY % cxxClassTemplateParamType "cxxClassTemplateParamType"> |
59 <!ENTITY % cxxClassTemplateParameterType "cxxClassTemplateParameterType"> |
59 <!ENTITY % cxxClassTemplateParamDeclarationName "cxxClassTemplateParamDeclarationName"> |
|
60 <!ENTITY % cxxClassTemplateParamDefinitionName "cxxClassTemplateParamDefinitionName"> |
|
61 |
60 |
62 <!-- Derivation --> |
61 <!-- Derivation --> |
63 <!ENTITY % cxxClassDerivationAccessSpecifier "cxxClassDerivationAccessSpecifier"> |
62 <!ENTITY % cxxClassDerivationAccessSpecifier "cxxClassDerivationAccessSpecifier"> |
64 <!ENTITY % cxxClassDerivationVirtual "cxxClassDerivationVirtual"> |
63 <!ENTITY % cxxClassDerivationVirtual "cxxClassDerivationVirtual"> |
65 <!ENTITY % cxxClassBaseClass "cxxClassBaseClass"> |
64 <!ENTITY % cxxClassBaseClass "cxxClassBaseClass"> |
128 |
127 |
129 <!ELEMENT cxxClassDefinition ( |
128 <!ELEMENT cxxClassDefinition ( |
130 (%cxxClassAccessSpecifier;)?, |
129 (%cxxClassAccessSpecifier;)?, |
131 (%cxxClassAbstract;)?, |
130 (%cxxClassAbstract;)?, |
132 (%cxxClassDerivations;)?, |
131 (%cxxClassDerivations;)?, |
133 (%cxxClassTemplateParamList;)?, |
132 (%cxxClassTemplateParameters;)?, |
134 (%cxxClassAPIItemLocation;) |
133 (%cxxClassAPIItemLocation;) |
135 ) |
134 ) |
136 > |
135 > |
137 <!ATTLIST cxxClassDefinition spectitle CDATA #IMPLIED |
136 <!ATTLIST cxxClassDefinition spectitle CDATA #IMPLIED |
138 %univ-atts; |
137 %univ-atts; |
281 scope (local | peer | external) #IMPLIED |
280 scope (local | peer | external) #IMPLIED |
282 outputclass CDATA #IMPLIED |
281 outputclass CDATA #IMPLIED |
283 > |
282 > |
284 |
283 |
285 <!-- Templates--> |
284 <!-- Templates--> |
286 |
285 <!ELEMENT cxxClassTemplateParameters (%cxxClassTemplateParameter;)+ > |
287 <!ELEMENT cxxClassTemplateParamList (%cxxClassTemplateParameter;)+ > |
286 <!ATTLIST cxxClassTemplateParameters %univ-atts; |
288 <!ATTLIST cxxClassTemplateParamList %univ-atts; |
287 outputclass CDATA #IMPLIED |
289 outputclass CDATA #IMPLIED |
288 > |
290 > |
289 |
291 |
290 <!ELEMENT cxxClassTemplateParameter (%cxxClassTemplateParameterType;, |
292 <!ELEMENT cxxClassTemplateParameter ( %cxxClassTemplateParamType;, |
291 (%apiDefNote;)? |
293 (%cxxClassTemplateParamDeclarationName;)?, |
292 ) |
294 (%cxxClassTemplateParamDefinitionName;)? |
|
295 ) |
|
296 > |
293 > |
297 <!ATTLIST cxxClassTemplateParameter %univ-atts; |
294 <!ATTLIST cxxClassTemplateParameter %univ-atts; |
298 outputclass CDATA #IMPLIED |
295 outputclass CDATA #IMPLIED |
299 > |
296 > |
300 |
297 |
301 <!ELEMENT cxxClassTemplateParamType (#PCDATA)*> |
298 <!ELEMENT cxxClassTemplateParameterType (#PCDATA | %apiRelation;)*> |
302 <!ATTLIST cxxClassTemplateParamType %univ-atts; |
299 <!ATTLIST cxxClassTemplateParameterType %univ-atts; |
303 outputclass CDATA #IMPLIED |
300 outputclass CDATA #IMPLIED |
304 > |
|
305 |
|
306 <!ELEMENT cxxClassTemplateParamDeclarationName (#PCDATA)*> |
|
307 <!ATTLIST cxxClassTemplateParamDeclarationName %univ-atts; |
|
308 outputclass CDATA #IMPLIED |
|
309 > |
|
310 |
|
311 <!ELEMENT cxxClassTemplateParamDefinitionName (#PCDATA)*> |
|
312 <!ATTLIST cxxClassTemplateParamDefinitionName %univ-atts; |
|
313 outputclass CDATA #IMPLIED |
|
314 > |
301 > |
315 |
302 |
316 <!-- Location --> |
303 <!-- Location --> |
317 <!ELEMENT cxxClassAPIItemLocation ( |
304 <!ELEMENT cxxClassAPIItemLocation ( |
318 %cxxClassDeclarationFile;, |
305 %cxxClassDeclarationFile;, |
319 %cxxClassDeclarationFileLine;, |
306 %cxxClassDeclarationFileLine;, |
320 %cxxClassDefinitionFile;?, |
307 (%cxxClassDefinitionFile;)?, |
321 %cxxClassDefinitionFileLineStart;?, |
308 (%cxxClassDefinitionFileLineStart;)?, |
322 %cxxClassDefinitionFileLineEnd;? |
309 (%cxxClassDefinitionFileLineEnd;)? |
323 ) |
310 ) |
324 > |
311 > |
325 <!ATTLIST cxxClassAPIItemLocation %univ-atts; |
312 <!ATTLIST cxxClassAPIItemLocation %univ-atts; |
326 outputclass CDATA #IMPLIED |
313 outputclass CDATA #IMPLIED |
327 > |
314 > |
441 class CDATA "- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier cxxClass/cxxClassBaseStruct "> |
428 class CDATA "- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier cxxClass/cxxClassBaseStruct "> |
442 <!ATTLIST cxxClassBaseUnion %global-atts; |
429 <!ATTLIST cxxClassBaseUnion %global-atts; |
443 class CDATA "- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier cxxClass/cxxClassBaseUnion "> |
430 class CDATA "- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier cxxClass/cxxClassBaseUnion "> |
444 |
431 |
445 <!-- Templates --> |
432 <!-- Templates --> |
446 <!ATTLIST cxxClassTemplateParamList %global-atts; |
433 <!ATTLIST cxxClassTemplateParameters %global-atts; |
447 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxClass/cxxClassTemplateParamList "> |
434 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxClass/cxxClassTemplateParameters "> |
448 <!ATTLIST cxxClassTemplateParameter %global-atts; |
435 <!ATTLIST cxxClassTemplateParameter %global-atts; |
449 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxClass/cxxClassTemplateParameter "> |
436 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxClass/cxxClassTemplateParameter "> |
450 <!ATTLIST cxxClassTemplateParamType %global-atts; |
437 <!ATTLIST cxxClassTemplateParameterType %global-atts; |
451 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxClass/cxxClassTemplateParamType "> |
438 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiClassifier/apiDefItem cxxClass/cxxClassTemplateParameterType "> |
452 <!ATTLIST cxxClassTemplateParamDeclarationName %global-atts; |
|
453 class CDATA "- topic/keyword reference/keyword apiRef/apiItemName apiClassifier/apiItemName cxxClass/cxxClassTemplateParamDeclarationName "> |
|
454 <!ATTLIST cxxClassTemplateParamDefinitionName %global-atts; |
|
455 class CDATA "- topic/keyword reference/keyword apiRef/apiItemName apiClassifier/apiItemName cxxClass/cxxClassTemplateParamDefinitionName "> |
|
456 |
439 |
457 <!-- Nested members --> |
440 <!-- Nested members --> |
458 <!ATTLIST cxxClassNested %global-atts; |
441 <!ATTLIST cxxClassNested %global-atts; |
459 class CDATA "- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier cxxClass/cxxClassNested "> |
442 class CDATA "- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier cxxClass/cxxClassNested "> |
460 <!ATTLIST cxxClassNestedDetail %global-atts; |
443 <!ATTLIST cxxClassNestedDetail %global-atts; |