source: BMXNET_RPMS_dotNET_UTILITIES-BMX/branch/IHS BMX Framework/IndianHealthService.BMXNet.GeneratedDocumentation/Help/Schemas/developerReference.xsd@ 1153

Last change on this file since 1153 was 1146, checked in by Sam Habiel, 14 years ago

Initial Import of BMX4

File size: 17.6 KB
Line 
1<?xml version="1.0" encoding="utf-8" ?>
2<schema
3 xmlns="http://www.w3.org/2001/XMLSchema"
4 xmlns:maml="http://ddue.schemas.microsoft.com/authoring/2003/5"
5 xmlns:doc="http://ddue.schemas.microsoft.com/authoring/internal"
6 targetNamespace="http://ddue.schemas.microsoft.com/authoring/2003/5"
7 blockDefault="#all"
8 elementFormDefault="qualified"
9 attributeFormDefault="unqualified"
10 xml:lang="en"
11 >
12
13 <!-- Schema documentation -->
14 <annotation>
15 <documentation>
16 This schema describes MAML, the Microsoft Assistance Markup Language.
17 MAML is intended for software documentation. In particular, it is
18 intended to accomodate the needs of Microsoft documentation.
19 </documentation>
20 <documentation>
21 The schema is broken into three main areas: end user, developer and
22 IT Pro. These areas adequaltely categorize Microsoft
23 documentation.
24 </documentation>
25 <documentation>
26 The namespace uri for this version of Maml is: http://ddue.schemas.microsoft.com/authoring/2003/5.
27 Each backwards-incompatible revision to Maml will require that the date fields be appropriately
28 incremented in uri of the updated version of the Maml schema.
29 </documentation>
30 </annotation>
31
32 <annotation>
33 <documentation>
34 This portion of the schema was created by alexstoc in April 2003.
35 </documentation>
36 </annotation>
37
38 <include schemaLocation="baseConditional.xsd"/>
39 <include schemaLocation="inline.xsd"/>
40 <include schemaLocation="block.xsd"/>
41 <include schemaLocation="structure.xsd"/>
42 <include schemaLocation="developerStructure.xsd"/>
43
44
45 <!-- ************ Start of assembly ************ -->
46
47 <element name="assemblyName" type="token">
48 <annotation>
49 <documentation>
50 </documentation>
51 <appinfo>
52 <doc:localizable>false</doc:localizable>
53 <doc:type>paragraph</doc:type>
54 </appinfo>
55 </annotation>
56 </element>
57
58 <element name="assemblyVersion" type="token">
59 <annotation>
60 <documentation>
61 </documentation>
62 <appinfo>
63 <doc:localizable>false</doc:localizable>
64 <doc:type>paragraph</doc:type>
65 </appinfo>
66 </annotation>
67 </element>
68
69 <element name="assemblyCulture" type="token">
70 <annotation>
71 <documentation>
72 </documentation>
73 <appinfo>
74 <doc:localizable>false</doc:localizable>
75 <doc:type>paragraph</doc:type>
76 </appinfo>
77 </annotation>
78 </element>
79
80 <element name="assemblyPublicKey" type="token">
81 <annotation>
82 <documentation>
83 </documentation>
84 <appinfo>
85 <doc:localizable>false</doc:localizable>
86 <doc:type>paragraph</doc:type>
87 </appinfo>
88 </annotation>
89 </element>
90
91 <element name="assemblyHash" type="token">
92 <annotation>
93 <documentation>
94 </documentation>
95 <appinfo>
96 <doc:localizable>false</doc:localizable>
97 <doc:type>paragraph</doc:type>
98 </appinfo>
99 </annotation>
100 </element>
101
102 <complexType name="assemblyType" mixed="false">
103 <sequence>
104 <element ref="maml:assemblyName"/>
105 <element ref="maml:assemblyVersion" minOccurs="0"/>
106 <element ref="maml:assemblyCulture" minOccurs="0"/>
107 <element ref="maml:assemblyPublicKey" minOccurs="0"/>
108 <element ref="maml:assemblyHash" minOccurs="0"/>
109 </sequence>
110 </complexType>
111
112 <element name="assembly" type="maml:assemblyType">
113 <annotation>
114 <documentation>
115 </documentation>
116 <appinfo>
117 <doc:localizable>n/a</doc:localizable>
118 <doc:type>section</doc:type>
119 </appinfo>
120 </annotation>
121 </element>
122
123 <!-- ************ End of assembly ************ -->
124
125 <element name="internalOnly" type="maml:emptyType">
126 <annotation>
127 <documentation>
128 This element is used to mark code entities that are only
129 intended for internal use and are not intended to be used
130 by external developers. This element should be used rarely.
131 The desire to use this element may indicate a design problem
132 with the library that should be fixed by the internal developers
133 before the product is released.
134 </documentation>
135 <appinfo>
136 <doc:localizable>n/a</doc:localizable>
137 <doc:type>section</doc:type>
138 </appinfo>
139 </annotation>
140 </element>
141
142 <element name="useBase" type="maml:emptyType">
143 <annotation>
144 <documentation>
145 This element is used to mark code entities that should use the documentation
146 of its base.
147 </documentation>
148 <appinfo>
149 <doc:localizable>n/a</doc:localizable>
150 <doc:type>section</doc:type>
151 </appinfo>
152 </annotation>
153 </element>
154
155 <element name="returnValue" type="maml:sectionContentType">
156 <annotation>
157 <documentation>
158 This element contains a description of the return value of a function or property.
159 </documentation>
160 <appinfo>
161 <doc:localizable>n/a</doc:localizable>
162 <doc:type>section</doc:type>
163 </appinfo>
164 </annotation>
165 </element>
166
167 <element name="threadSafety" type="maml:sectionContentType">
168 <annotation>
169 <documentation>
170 This element contains a discussion of the thread safety characteristics of the current item.
171 </documentation>
172 <appinfo>
173 <doc:localizable>n/a</doc:localizable>
174 <doc:type>section</doc:type>
175 </appinfo>
176 </annotation>
177 </element>
178
179 <element name="notesForImplementers" type="maml:sectionContentType">
180 <annotation>
181 <documentation>
182 This element contains information that is only relevant to implementers of the current item.
183 </documentation>
184 <appinfo>
185 <doc:localizable>n/a</doc:localizable>
186 <doc:type>section</doc:type>
187 </appinfo>
188 </annotation>
189 </element>
190
191 <element name="notesForCallers" type="maml:sectionContentType">
192 <annotation>
193 <documentation>
194 This element contains information that is only relevant to callers of the current item.
195 </documentation>
196 <appinfo>
197 <doc:localizable>n/a</doc:localizable>
198 <doc:type>section</doc:type>
199 </appinfo>
200 </annotation>
201 </element>
202
203 <element name="notesForInheritors" type="maml:sectionContentType">
204 <annotation>
205 <documentation>
206 This element contains information that is only relevant to inheritors of the current item.
207 </documentation>
208 <appinfo>
209 <doc:localizable>n/a</doc:localizable>
210 <doc:type>section</doc:type>
211 </appinfo>
212 </annotation>
213 </element>
214
215 <complexType name="codeReferenceDescriptionType" mixed="false">
216 <sequence>
217 <element ref="maml:codeEntityReference"/>
218 <element ref="maml:content"/>
219 </sequence>
220 </complexType>
221
222 <complexType name="parameterReferenceDescriptionType" mixed="false">
223 <sequence>
224 <element ref="maml:parameterReference"/>
225 <element ref="maml:content"/>
226 </sequence>
227 </complexType>
228
229 <element name="clsCompliantAlternative" type="maml:codeReferenceDescriptionType">
230 <annotation>
231 <documentation>
232 This is a reference to another code entity that performs a
233 function similar to that of the current code entity. Unlike the
234 current entity, the target of the reference is CLS-compliant.
235 </documentation>
236 <appinfo>
237 <doc:localizable>n/a</doc:localizable>
238 <doc:type>section</doc:type>
239 </appinfo>
240 </annotation>
241 </element>
242
243 <element name="equivalentCodeEntity" type="maml:codeReferenceDescriptionType">
244 <annotation>
245 <documentation>
246 This is a reference to another code entity that performs
247 the same function as the current code entity. It is typically used
248 for mapping from an operator to the equivalent function (such as
249 from op_Equality to Equals).
250 </documentation>
251 <appinfo>
252 <doc:localizable>n/a</doc:localizable>
253 <doc:type>section</doc:type>
254 </appinfo>
255 </annotation>
256 </element>
257
258 <element name="obsoleteCodeEntity" type="maml:codeReferenceDescriptionType">
259 <annotation>
260 <documentation>
261 This is used to indicate that a code entity is obsolete.It may contain
262 a reference to another code entity that users are encouraged to use instead of the
263 current code entity.
264 </documentation>
265 <appinfo>
266 <doc:localizable>n/a</doc:localizable>
267 <doc:type>section</doc:type>
268 </appinfo>
269 </annotation>
270 </element>
271
272 <element name="unmanagedCodeEntity" type="maml:codeReferenceDescriptionType">
273 <annotation>
274 <documentation>
275 It may contain a reference to a unmanaged code entity.
276 </documentation>
277 <appinfo>
278 <doc:localizable>n/a</doc:localizable>
279 <doc:type>section</doc:type>
280 </appinfo>
281 </annotation>
282 </element>
283
284 <element name="genericParameter" type="maml:parameterReferenceDescriptionType">
285 <annotation>
286 <documentation>
287 This element contains a description of a generic or template parameter.
288 </documentation>
289 <appinfo>
290 <doc:localizable>n/a</doc:localizable>
291 <doc:type>section</doc:type>
292 </appinfo>
293 </annotation>
294 </element>
295
296 <complexType name="genericParametersType" mixed="false">
297 <sequence>
298 <element ref="maml:genericParameter" minOccurs="0" maxOccurs="unbounded"/>
299 </sequence>
300 </complexType>
301
302 <element name="genericParameters" type="maml:genericParametersType">
303 <annotation>
304 <documentation>
305 This element is a collection of genericParameter elements.
306 </documentation>
307 <appinfo>
308 <doc:localizable>n/a</doc:localizable>
309 <doc:type>section</doc:type>
310 </appinfo>
311 </annotation>
312 </element>
313
314 <element name="parameter" type="maml:parameterReferenceDescriptionType">
315 <annotation>
316 <documentation>
317 This element contains a description of a functional parameter.
318 </documentation>
319 <appinfo>
320 <doc:localizable>n/a</doc:localizable>
321 <doc:type>section</doc:type>
322 </appinfo>
323 </annotation>
324 </element>
325
326 <complexType name="parametersType" mixed="false">
327 <sequence>
328 <element ref="maml:parameter" minOccurs="0" maxOccurs="unbounded"/>
329 </sequence>
330 </complexType>
331
332 <element name="parameters" type="maml:parametersType">
333 <annotation>
334 <documentation>
335 This element is a collection of parameter elements.
336 </documentation>
337 <appinfo>
338 <doc:localizable>n/a</doc:localizable>
339 <doc:type>section</doc:type>
340 </appinfo>
341 </annotation>
342 </element>
343
344 <element name="exception" type="maml:codeReferenceDescriptionType">
345 <annotation>
346 <documentation>
347 This element contains a description of one type of exception.
348 </documentation>
349 <appinfo>
350 <doc:localizable>n/a</doc:localizable>
351 <doc:type>section</doc:type>
352 </appinfo>
353 </annotation>
354 </element>
355
356 <complexType name="exceptionsType" mixed="false">
357 <sequence>
358 <element ref="maml:exception" minOccurs="0" maxOccurs="unbounded"/>
359 </sequence>
360 </complexType>
361
362 <element name="exceptions" type="maml:exceptionsType">
363 <annotation>
364 <documentation>
365 This element is a collection of exception elements.
366 </documentation>
367 <appinfo>
368 <doc:localizable>n/a</doc:localizable>
369 <doc:type>section</doc:type>
370 </appinfo>
371 </annotation>
372 </element>
373
374 <element name="permission" type="maml:codeReferenceDescriptionType">
375 <annotation>
376 <documentation>
377 This element holds a discussion of a particular permission required
378 to use the current code element.
379 </documentation>
380 <appinfo>
381 <doc:localizable>n/a</doc:localizable>
382 <doc:type>section</doc:type>
383 </appinfo>
384 </annotation>
385 </element>
386
387 <complexType name="permissionsType" mixed="false">
388 <sequence>
389 <element ref="maml:permission" minOccurs="0" maxOccurs="unbounded"/>
390 </sequence>
391 </complexType>
392
393 <element name="permissions" type="maml:permissionsType">
394 <annotation>
395 <documentation>
396 This element is a collection of permission elements.
397 </documentation>
398 <appinfo>
399 <doc:localizable>n/a</doc:localizable>
400 <doc:type>section</doc:type>
401 </appinfo>
402 </annotation>
403 </element>
404
405 <complexType name="platformNoteType" mixed="false">
406 <sequence>
407 <element ref="maml:platforms"/>
408 <element ref="maml:content"/>
409 </sequence>
410 </complexType>
411
412 <element name="platformNote" type="maml:platformNoteType">
413 <annotation>
414 <documentation>
415 This element contains a collection of platforms
416 along with a discussion of the behavior of the current code entity on those platforms.
417 </documentation>
418 <appinfo>
419 <doc:localizable>n/a</doc:localizable>
420 <doc:type>section</doc:type>
421 </appinfo>
422 </annotation>
423 </element>
424
425 <complexType name="platformNotesType" mixed="false">
426 <sequence>
427 <element ref="maml:platformNote" minOccurs="0" maxOccurs="unbounded"/>
428 </sequence>
429 </complexType>
430
431 <element name="platformNotes" type="maml:platformNotesType">
432 <annotation>
433 <documentation>
434 This element is a collection of platformNote elements.
435 </documentation>
436 <appinfo>
437 <doc:localizable>n/a</doc:localizable>
438 <doc:type>section</doc:type>
439 </appinfo>
440 </annotation>
441 </element>
442
443 <complexType name="codeEntityType" mixed="false">
444 <sequence>
445 <element ref="maml:codeEntityReference"/>
446 <choice maxOccurs="unbounded">
447 <element ref="maml:internalOnly" minOccurs="0"/>
448 <element ref="maml:useBase" minOccurs="0"/>
449 <element ref="maml:clsCompliantAlternative" minOccurs="0"/>
450 <element ref="maml:equivalentCodeEntity" minOccurs="0"/>
451 <element ref="maml:obsoleteCodeEntity" minOccurs="0"/>
452 <element ref="maml:unmanagedCodeEntity" minOccurs="0"/>
453 </choice>
454 <element ref="maml:summary" minOccurs="0"/>
455 <element ref="maml:genericParameters" minOccurs="0"/>
456 <element ref="maml:parameters" minOccurs="0"/>
457 <element ref="maml:returnValue" minOccurs="0"/>
458 <element ref="maml:exceptions" minOccurs="0"/>
459 <element ref="maml:threadSafety" minOccurs="0"/>
460 <element ref="maml:remarks" minOccurs="0"/>
461 <element ref="maml:notesForImplementers" minOccurs="0"/>
462 <element ref="maml:notesForCallers" minOccurs="0"/>
463 <element ref="maml:notesForInheritors" minOccurs="0"/>
464 <element ref="maml:platformNotes" minOccurs="0"/>
465 <element ref="maml:codeExamples" minOccurs="0" />
466 <element ref="maml:permissions" minOccurs="0"/>
467 <element ref="maml:relatedTopics" minOccurs="0"/>
468 </sequence>
469 </complexType>
470
471 <element name="codeEntity" type="maml:codeEntityType">
472 <annotation>
473 <documentation>
474 This element contains the documentation for a single code entity.
475 A code entity is a type, member, or overload-set.
476 The code entity is identified by the one and only codeEntityReference element
477 that is a child of this element.
478 </documentation>
479 <appinfo>
480 <doc:localizable>n/a</doc:localizable>
481 <doc:type>section</doc:type>
482 </appinfo>
483 </annotation>
484 </element>
485
486 <complexType name="codeEntitiesType" mixed="false">
487 <sequence>
488 <element ref="maml:codeEntity" minOccurs="0" maxOccurs="unbounded"/>
489 </sequence>
490 </complexType>
491
492 <element name="codeEntities" type="maml:codeEntitiesType">
493 <annotation>
494 <documentation>
495 This element is a simple collection of codeEntity elements.
496 </documentation>
497 <appinfo>
498 <doc:localizable>n/a</doc:localizable>
499 <doc:type>section</doc:type>
500 </appinfo>
501 </annotation>
502 </element>
503
504</schema>
Note: See TracBrowser for help on using the repository browser.