|
1 <!-- ================================================================= --> |
|
2 <!-- HEADER --> |
|
3 <!-- ================================================================= --> |
|
4 <!-- MODULE: C++ Define DTD --> |
|
5 <!-- VERSION: 0.5.0 --> |
|
6 <!-- DATE: February 2009 --> |
|
7 <!-- --> |
|
8 <!-- ================================================================= --> |
|
9 |
|
10 <!-- ================================================================= --> |
|
11 <!-- PUBLIC DOCUMENT TYPE DEFINITION --> |
|
12 <!-- TYPICAL INVOCATION --> |
|
13 <!-- --> |
|
14 <!-- Refer to this file by the following public identifier or an |
|
15 appropriate system identifier |
|
16 PUBLIC "-//NOKIA//DTD DITA C++ API Define Reference Type v0.5.0//EN" |
|
17 Delivered as file "cxxDefine.dtd" --> |
|
18 |
|
19 <!-- ================================================================= --> |
|
20 <!-- SYSTEM: Darwin Information Typing Architecture (DITA) --> |
|
21 <!-- --> |
|
22 <!-- PURPOSE: C++ API Reference for Defines --> |
|
23 <!-- --> |
|
24 <!-- ORIGINAL CREATION DATE: --> |
|
25 <!-- November 2009 --> |
|
26 <!-- --> |
|
27 <!-- Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). --> |
|
28 <!-- All rights reserved. --> |
|
29 <!-- --> |
|
30 <!-- Change History (latest at top): --> |
|
31 <!-- +++++++++++++++++++++++++++++++ --> |
|
32 <!-- 2010-02-16 VOG: Updated. --> |
|
33 <!-- 2010-02-10 PaulRoss: Updated. --> |
|
34 <!-- 2009-11-16 PaulRoss: Initial design. --> |
|
35 <!-- --> |
|
36 <!-- ================================================================= --> |
|
37 |
|
38 <!-- |
|
39 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
40 All rights reserved. |
|
41 --> |
|
42 |
|
43 <!-- ============ Hooks for domain extension ============ --> |
|
44 <!ENTITY % cxxDefine "cxxDefine"> |
|
45 <!ENTITY % cxxDefineDetail "cxxDefineDetail"> |
|
46 <!ENTITY % cxxDefineDefinition "cxxDefineDefinition"> |
|
47 |
|
48 <!ENTITY % cxxDefinePrototype "cxxDefinePrototype"> |
|
49 <!ENTITY % cxxDefineNameLookup "cxxDefineNameLookup"> |
|
50 <!ENTITY % cxxDefineReimplemented "cxxDefineReimplemented"> |
|
51 |
|
52 <!-- Parameters --> |
|
53 <!ENTITY % cxxDefineParameters "cxxDefineParameters"> |
|
54 <!ENTITY % cxxDefineParameter "cxxDefineParameter"> |
|
55 <!ENTITY % cxxDefineParameterDeclarationName "cxxDefineParameterDeclarationName"> |
|
56 |
|
57 <!ENTITY % cxxDefineAccessSpecifier "cxxDefineAccessSpecifier"> |
|
58 |
|
59 <!-- Location information --> |
|
60 <!ENTITY % cxxDefineAPIItemLocation "cxxDefineAPIItemLocation"> |
|
61 <!ENTITY % cxxDefineDeclarationFile "cxxDefineDeclarationFile"> |
|
62 <!ENTITY % cxxDefineDeclarationFileLine "cxxDefineDeclarationFileLine"> |
|
63 |
|
64 <!-- ============ Hooks for shell DTD ============ --> |
|
65 <!ENTITY % cxxDefine-types-default "no-topic-nesting"> |
|
66 <!ENTITY % cxxDefine-info-types "%cxxDefine-types-default;"> |
|
67 |
|
68 <!ENTITY included-domains ""> |
|
69 |
|
70 |
|
71 <!-- ============ Topic specializations ============ --> |
|
72 <!ELEMENT cxxDefine ( (%apiName;), (%shortdesc;)?, (%prolog;)?, (%cxxDefineDetail;), (%related-links;)?, (%cxxDefine-info-types;)* )> |
|
73 <!ATTLIST cxxDefine id ID #REQUIRED |
|
74 conref CDATA #IMPLIED |
|
75 outputclass CDATA #IMPLIED |
|
76 xml:lang NMTOKEN #IMPLIED |
|
77 %arch-atts; |
|
78 domains CDATA "&included-domains;" |
|
79 > |
|
80 |
|
81 <!ELEMENT cxxDefineDetail (%cxxDefineDefinition;, (%apiDesc;)?, (%example; | %section; | %apiImpl;)*)> |
|
82 <!ATTLIST cxxDefineDetail %id-atts; |
|
83 translate (yes|no) #IMPLIED |
|
84 xml:lang NMTOKEN #IMPLIED |
|
85 outputclass CDATA #IMPLIED> |
|
86 |
|
87 <!ELEMENT cxxDefineDefinition ( |
|
88 (%cxxDefineAccessSpecifier;)?, |
|
89 |
|
90 (%cxxDefinePrototype;)?, |
|
91 (%cxxDefineNameLookup;)?, |
|
92 |
|
93 (%cxxDefineReimplemented;)?, |
|
94 |
|
95 (%cxxDefineParameters;)?, |
|
96 |
|
97 (%cxxDefineAPIItemLocation;)? |
|
98 ) |
|
99 > |
|
100 <!ATTLIST cxxDefineDefinition spectitle CDATA #IMPLIED |
|
101 %univ-atts; |
|
102 outputclass CDATA #IMPLIED |
|
103 > |
|
104 |
|
105 |
|
106 <!ELEMENT cxxDefineAccessSpecifier EMPTY> |
|
107 <!ATTLIST cxxDefineAccessSpecifier name CDATA #FIXED "access" |
|
108 value CDATA #FIXED "public" |
|
109 %univ-atts; |
|
110 outputclass CDATA #IMPLIED |
|
111 > |
|
112 |
|
113 <!ELEMENT cxxDefinePrototype (#PCDATA)*> |
|
114 <!ATTLIST cxxDefinePrototype %univ-atts; |
|
115 outputclass CDATA #IMPLIED |
|
116 > |
|
117 |
|
118 <!ELEMENT cxxDefineNameLookup (#PCDATA)*> |
|
119 <!ATTLIST cxxDefineNameLookup %univ-atts; |
|
120 outputclass CDATA #IMPLIED |
|
121 > |
|
122 |
|
123 <!ELEMENT cxxDefineReimplemented (#PCDATA)*> |
|
124 <!ATTLIST cxxDefineReimplemented href CDATA #IMPLIED |
|
125 keyref CDATA #IMPLIED |
|
126 type CDATA #IMPLIED |
|
127 %univ-atts; |
|
128 format CDATA #IMPLIED |
|
129 scope (local | peer | external) #IMPLIED |
|
130 outputclass CDATA #IMPLIED |
|
131 > |
|
132 |
|
133 <!ELEMENT cxxDefineParameters (%cxxDefineParameter;)* > |
|
134 <!ATTLIST cxxDefineParameters %univ-atts; |
|
135 outputclass CDATA #IMPLIED |
|
136 > |
|
137 |
|
138 <!ELEMENT cxxDefineParameter ( |
|
139 (%cxxDefineParameterDeclarationName;)?, |
|
140 (%apiDefNote;)? |
|
141 ) |
|
142 > |
|
143 <!ATTLIST cxxDefineParameter %univ-atts; |
|
144 outputclass CDATA #IMPLIED |
|
145 > |
|
146 |
|
147 <!ELEMENT cxxDefineParameterDeclarationName (#PCDATA)*> |
|
148 <!ATTLIST cxxDefineParameterDeclarationName %univ-atts; |
|
149 outputclass CDATA #IMPLIED |
|
150 > |
|
151 |
|
152 <!-- Location information --> |
|
153 <!ELEMENT cxxDefineAPIItemLocation (%cxxDefineDeclarationFile;, %cxxDefineDeclarationFileLine;) |
|
154 > |
|
155 <!ATTLIST cxxDefineAPIItemLocation %univ-atts; |
|
156 outputclass CDATA #IMPLIED |
|
157 > |
|
158 |
|
159 <!ELEMENT cxxDefineDeclarationFile EMPTY> |
|
160 <!ATTLIST cxxDefineDeclarationFile name CDATA #FIXED "filePath" |
|
161 value CDATA #REQUIRED |
|
162 %univ-atts; |
|
163 outputclass CDATA #IMPLIED |
|
164 > |
|
165 |
|
166 <!ELEMENT cxxDefineDeclarationFileLine EMPTY> |
|
167 <!ATTLIST cxxDefineDeclarationFileLine name CDATA #FIXED "lineNumber" |
|
168 value CDATA #REQUIRED |
|
169 %univ-atts; |
|
170 outputclass CDATA #IMPLIED |
|
171 > |
|
172 |
|
173 |
|
174 <!-- ============ Class attributes for type ancestry ============ --> |
|
175 <!ATTLIST cxxDefine %global-atts; |
|
176 class CDATA "- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation cxxDefine/cxxDefine "> |
|
177 <!ATTLIST cxxDefineDetail %global-atts; |
|
178 class CDATA "- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail cxxDefine/cxxDefineDetail "> |
|
179 <!ATTLIST cxxDefineDefinition %global-atts; |
|
180 class CDATA "- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef cxxDefine/cxxDefineDefinition "> |
|
181 |
|
182 <!-- Location elements --> |
|
183 <!ATTLIST cxxDefineAPIItemLocation %global-atts; |
|
184 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiDefItem cxxDefine/cxxDefineAPIItemLocation "> |
|
185 <!ATTLIST cxxDefineDeclarationFile %global-atts; |
|
186 class CDATA "- topic/state reference/state apiRef/apiQualifier apiOperation/apiQualifier cxxDefine/cxxDefineDeclarationFile "> |
|
187 <!ATTLIST cxxDefineDeclarationFileLine %global-atts; |
|
188 class CDATA "- topic/state reference/state apiRef/apiQualifier apiOperation/apiQualifier cxxDefine/cxxDefineDeclarationFileLine "> |
|
189 |
|
190 <!ATTLIST cxxDefineAccessSpecifier %global-atts; |
|
191 class CDATA "- topic/state reference/state apiRef/apiQualifier apiOperation/apiQualifier cxxDefine/cxxDefineAccessSpecifier "> |
|
192 |
|
193 <!ATTLIST cxxDefineNameLookup %global-atts; |
|
194 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiDefItem cxxDefine/cxxDefineNameLookup "> |
|
195 <!ATTLIST cxxDefinePrototype %global-atts; |
|
196 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiDefItem cxxDefine/cxxDefinePrototype "> |
|
197 <!ATTLIST cxxDefineParameters %global-atts; |
|
198 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiDefItem cxxDefine/cxxDefineParameters "> |
|
199 <!ATTLIST cxxDefineParameter %global-atts; |
|
200 class CDATA "- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiDefItem cxxDefine/cxxDefineParameter "> |
|
201 <!ATTLIST cxxDefineParameterDeclarationName %global-atts; |
|
202 class CDATA "- topic/keyword reference/keyword apiRef/apiItemName apiOperation/apiItemName cxxDefine/cxxDefineParameterDeclarationName "> |
|
203 |
|
204 <!ATTLIST cxxDefineReimplemented %global-atts; |
|
205 class CDATA "- topic/xref reference/xref apiRef/apiRelation apiOperation/apiRelation cxxDefine/cxxDefineReimplemented "> |