[b1a51ac1] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!--
|
---|
| 3 | This file is part of DocBook V5.0
|
---|
| 4 |
|
---|
| 5 | Copyright 1992-2008 HaL Computer Systems, Inc.,
|
---|
| 6 | O'Reilly & Associates, Inc., ArborText, Inc., Fujitsu Software
|
---|
| 7 | Corporation, Norman Walsh, Sun Microsystems, Inc., and the
|
---|
| 8 | Organization for the Advancement of Structured Information
|
---|
| 9 | Standards (OASIS).
|
---|
| 10 |
|
---|
| 11 | Release: $Id: pool.rnc 7466 2007-09-27 14:03:55Z nwalsh $
|
---|
| 12 |
|
---|
| 13 | Permission to use, copy, modify and distribute the DocBook schema
|
---|
| 14 | and its accompanying documentation for any purpose and without fee
|
---|
| 15 | is hereby granted in perpetuity, provided that the above copyright
|
---|
| 16 | notice and this paragraph appear in all copies. The copyright
|
---|
| 17 | holders make no representation about the suitability of the schema
|
---|
| 18 | for any purpose. It is provided "as is" without expressed or implied
|
---|
| 19 | warranty.
|
---|
| 20 |
|
---|
| 21 | If you modify the DocBook schema in any way, label your schema as a
|
---|
| 22 | variant of DocBook. See the reference documentation
|
---|
| 23 | (http://docbook.org/tdg5/en/html/ch05.html#s-notdocbook)
|
---|
| 24 | for more information.
|
---|
| 25 |
|
---|
| 26 | Please direct all questions, bug reports, or suggestions for changes
|
---|
| 27 | to the docbook@lists.oasis-open.org mailing list. For more
|
---|
| 28 | information, see http://www.oasis-open.org/docbook/.
|
---|
| 29 |
|
---|
| 30 | ======================================================================
|
---|
| 31 | -->
|
---|
| 32 | <grammar ns="http://docbook.org/ns/docbook" xmlns:db="http://docbook.org/ns/docbook" xmlns:s="http://purl.oclc.org/dsdl/schematron" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns:rng="http://relaxng.org/ns/structure/1.0" xmlns:ctrl="http://nwalsh.com/xmlns/schema-control/" xmlns="http://relaxng.org/ns/structure/1.0">
|
---|
| 33 | <start combine="choice">
|
---|
| 34 | <choice>
|
---|
| 35 | <ref name="db.synopsis.blocks"/>
|
---|
| 36 | <ref name="db.funcsynopsisinfo"/>
|
---|
| 37 | <ref name="db.classsynopsisinfo"/>
|
---|
| 38 | </choice>
|
---|
| 39 | </start>
|
---|
| 40 | <define name="db.domain.inlines" combine="choice">
|
---|
| 41 | <ref name="db.programming.inlines"/>
|
---|
| 42 | </define>
|
---|
| 43 | <define name="db.nopara.blocks" combine="choice">
|
---|
| 44 | <ref name="db.synopsis.blocks"/>
|
---|
| 45 | </define>
|
---|
| 46 | <define name="db.cover.contentmodel" combine="choice">
|
---|
| 47 | <ref name="db.synopsis.blocks"/>
|
---|
| 48 | </define>
|
---|
| 49 | <define name="db.verbatim.blocks" combine="choice">
|
---|
| 50 | <choice>
|
---|
| 51 | <ref name="db.programlisting"/>
|
---|
| 52 | <ref name="db.synopsis"/>
|
---|
| 53 | </choice>
|
---|
| 54 | </define>
|
---|
| 55 | <define name="db.programming.inlines">
|
---|
| 56 | <choice>
|
---|
| 57 | <ref name="db.function"/>
|
---|
| 58 | <ref name="db.parameter"/>
|
---|
| 59 | <ref name="db.varname"/>
|
---|
| 60 | <ref name="db.returnvalue"/>
|
---|
| 61 | <ref name="db.type"/>
|
---|
| 62 | <ref name="db.classname"/>
|
---|
| 63 | <ref name="db.exceptionname"/>
|
---|
| 64 | <ref name="db.interfacename"/>
|
---|
| 65 | <ref name="db.methodname"/>
|
---|
| 66 | <ref name="db.modifier"/>
|
---|
| 67 | <ref name="db.initializer"/>
|
---|
| 68 | <ref name="db.oo.inlines"/>
|
---|
| 69 | </choice>
|
---|
| 70 | </define>
|
---|
| 71 | <define name="db.oo.inlines">
|
---|
| 72 | <choice>
|
---|
| 73 | <ref name="db.ooclass"/>
|
---|
| 74 | <ref name="db.ooexception"/>
|
---|
| 75 | <ref name="db.oointerface"/>
|
---|
| 76 | </choice>
|
---|
| 77 | </define>
|
---|
| 78 | <define name="db.synopsis.blocks">
|
---|
| 79 | <choice>
|
---|
| 80 | <ref name="db.funcsynopsis"/>
|
---|
| 81 | <ref name="db.classsynopsis"/>
|
---|
| 82 | <ref name="db.methodsynopsis"/>
|
---|
| 83 | <ref name="db.constructorsynopsis"/>
|
---|
| 84 | <ref name="db.destructorsynopsis"/>
|
---|
| 85 | <ref name="db.fieldsynopsis"/>
|
---|
| 86 | </choice>
|
---|
| 87 | </define>
|
---|
| 88 | <!-- ====================================================================== -->
|
---|
| 89 | <div>
|
---|
| 90 | <db:refname>synopsis</db:refname>
|
---|
| 91 | <db:refpurpose>A general-purpose element for representing the syntax of commands or functions</db:refpurpose>
|
---|
| 92 | <define name="db.synopsis.role.attribute">
|
---|
| 93 | <attribute name="role"/>
|
---|
| 94 | </define>
|
---|
| 95 | <define name="db.synopsis.label.attribute">
|
---|
| 96 | <ref name="db.label.attribute"/>
|
---|
| 97 | </define>
|
---|
| 98 | <define name="db.synopsis.attlist">
|
---|
| 99 | <interleave>
|
---|
| 100 | <optional>
|
---|
| 101 | <ref name="db.synopsis.role.attribute"/>
|
---|
| 102 | </optional>
|
---|
| 103 | <ref name="db.common.attributes"/>
|
---|
| 104 | <ref name="db.common.linking.attributes"/>
|
---|
| 105 | <ref name="db.verbatim.attributes"/>
|
---|
| 106 | <optional>
|
---|
| 107 | <ref name="db.synopsis.label.attribute"/>
|
---|
| 108 | </optional>
|
---|
| 109 | </interleave>
|
---|
| 110 | </define>
|
---|
| 111 | <define name="db.synopsis">
|
---|
| 112 | <element name="synopsis">
|
---|
| 113 | <ref name="db.synopsis.attlist"/>
|
---|
| 114 | <ref name="db.verbatim.contentmodel"/>
|
---|
| 115 | </element>
|
---|
| 116 | </define>
|
---|
| 117 | </div>
|
---|
| 118 | <!-- ====================================================================== -->
|
---|
| 119 | <div>
|
---|
| 120 | <db:refname>funcsynopsis</db:refname>
|
---|
| 121 | <db:refpurpose>The syntax summary for a function definition</db:refpurpose>
|
---|
| 122 | <define name="db.funcsynopsis.role.attribute">
|
---|
| 123 | <attribute name="role"/>
|
---|
| 124 | </define>
|
---|
| 125 | <define name="db.funcsynopsis.attlist">
|
---|
| 126 | <interleave>
|
---|
| 127 | <optional>
|
---|
| 128 | <ref name="db.funcsynopsis.role.attribute"/>
|
---|
| 129 | </optional>
|
---|
| 130 | <ref name="db.common.attributes"/>
|
---|
| 131 | <ref name="db.common.linking.attributes"/>
|
---|
| 132 | <optional>
|
---|
| 133 | <ref name="db.language.attribute"/>
|
---|
| 134 | </optional>
|
---|
| 135 | </interleave>
|
---|
| 136 | </define>
|
---|
| 137 | <define name="db.funcsynopsis.info">
|
---|
| 138 | <ref name="db._info.title.forbidden"/>
|
---|
| 139 | </define>
|
---|
| 140 | <define name="db.funcsynopsis">
|
---|
| 141 | <element name="funcsynopsis">
|
---|
| 142 | <ref name="db.funcsynopsis.attlist"/>
|
---|
| 143 | <ref name="db.funcsynopsis.info"/>
|
---|
| 144 | <oneOrMore>
|
---|
| 145 | <choice>
|
---|
| 146 | <ref name="db.funcsynopsisinfo"/>
|
---|
| 147 | <ref name="db.funcprototype"/>
|
---|
| 148 | </choice>
|
---|
| 149 | </oneOrMore>
|
---|
| 150 | </element>
|
---|
| 151 | </define>
|
---|
| 152 | </div>
|
---|
| 153 | <!-- ====================================================================== -->
|
---|
| 154 | <div>
|
---|
| 155 | <db:refname>funcsynopsisinfo</db:refname>
|
---|
| 156 | <db:refpurpose>Information supplementing the funcdefs of a funcsynopsis</db:refpurpose>
|
---|
| 157 | <define name="db.funcsynopsisinfo.role.attribute">
|
---|
| 158 | <attribute name="role"/>
|
---|
| 159 | </define>
|
---|
| 160 | <define name="db.funcsynopsisinfo.attlist">
|
---|
| 161 | <interleave>
|
---|
| 162 | <optional>
|
---|
| 163 | <ref name="db.funcsynopsisinfo.role.attribute"/>
|
---|
| 164 | </optional>
|
---|
| 165 | <ref name="db.common.attributes"/>
|
---|
| 166 | <ref name="db.common.linking.attributes"/>
|
---|
| 167 | <ref name="db.verbatim.attributes"/>
|
---|
| 168 | </interleave>
|
---|
| 169 | </define>
|
---|
| 170 | <define name="db.funcsynopsisinfo">
|
---|
| 171 | <element name="funcsynopsisinfo">
|
---|
| 172 | <ref name="db.funcsynopsisinfo.attlist"/>
|
---|
| 173 | <ref name="db.verbatim.contentmodel"/>
|
---|
| 174 | </element>
|
---|
| 175 | </define>
|
---|
| 176 | </div>
|
---|
| 177 | <!-- ====================================================================== -->
|
---|
| 178 | <div>
|
---|
| 179 | <db:refname>funcprototype</db:refname>
|
---|
| 180 | <db:refpurpose>The prototype of a function</db:refpurpose>
|
---|
| 181 | <define name="db.funcprototype.role.attribute">
|
---|
| 182 | <attribute name="role"/>
|
---|
| 183 | </define>
|
---|
| 184 | <define name="db.funcprototype.attlist">
|
---|
| 185 | <interleave>
|
---|
| 186 | <optional>
|
---|
| 187 | <ref name="db.funcprototype.role.attribute"/>
|
---|
| 188 | </optional>
|
---|
| 189 | <ref name="db.common.attributes"/>
|
---|
| 190 | <ref name="db.common.linking.attributes"/>
|
---|
| 191 | </interleave>
|
---|
| 192 | </define>
|
---|
| 193 | <define name="db.funcprototype">
|
---|
| 194 | <element name="funcprototype">
|
---|
| 195 | <ref name="db.funcprototype.attlist"/>
|
---|
| 196 | <zeroOrMore>
|
---|
| 197 | <ref name="db.modifier"/>
|
---|
| 198 | </zeroOrMore>
|
---|
| 199 | <ref name="db.funcdef"/>
|
---|
| 200 | <choice>
|
---|
| 201 | <ref name="db.void"/>
|
---|
| 202 | <ref name="db.varargs"/>
|
---|
| 203 | <group>
|
---|
| 204 | <oneOrMore>
|
---|
| 205 | <choice>
|
---|
| 206 | <ref name="db.paramdef"/>
|
---|
| 207 | <ref name="db.group.paramdef"/>
|
---|
| 208 | </choice>
|
---|
| 209 | </oneOrMore>
|
---|
| 210 | <optional>
|
---|
| 211 | <ref name="db.varargs"/>
|
---|
| 212 | </optional>
|
---|
| 213 | </group>
|
---|
| 214 | </choice>
|
---|
| 215 | <zeroOrMore>
|
---|
| 216 | <ref name="db.modifier"/>
|
---|
| 217 | </zeroOrMore>
|
---|
| 218 | </element>
|
---|
| 219 | </define>
|
---|
| 220 | </div>
|
---|
| 221 | <!-- ====================================================================== -->
|
---|
| 222 | <div>
|
---|
| 223 | <db:refname>funcdef</db:refname>
|
---|
| 224 | <db:refpurpose>A function (subroutine) name and its return type</db:refpurpose>
|
---|
| 225 | <define name="db.funcdef.role.attribute">
|
---|
| 226 | <attribute name="role"/>
|
---|
| 227 | </define>
|
---|
| 228 | <define name="db.funcdef.attlist">
|
---|
| 229 | <interleave>
|
---|
| 230 | <optional>
|
---|
| 231 | <ref name="db.funcdef.role.attribute"/>
|
---|
| 232 | </optional>
|
---|
| 233 | <ref name="db.common.attributes"/>
|
---|
| 234 | <ref name="db.common.linking.attributes"/>
|
---|
| 235 | </interleave>
|
---|
| 236 | </define>
|
---|
| 237 | <define name="db.funcdef">
|
---|
| 238 | <element name="funcdef">
|
---|
| 239 | <ref name="db.funcdef.attlist"/>
|
---|
| 240 | <zeroOrMore>
|
---|
| 241 | <choice>
|
---|
| 242 | <ref name="db._text"/>
|
---|
| 243 | <ref name="db.type"/>
|
---|
| 244 | <ref name="db.function"/>
|
---|
| 245 | </choice>
|
---|
| 246 | </zeroOrMore>
|
---|
| 247 | </element>
|
---|
| 248 | </define>
|
---|
| 249 | </div>
|
---|
| 250 | <!-- ====================================================================== -->
|
---|
| 251 | <div>
|
---|
| 252 | <db:refname>function</db:refname>
|
---|
| 253 | <db:refpurpose>The name of a function or subroutine, as in a programming language</db:refpurpose>
|
---|
| 254 | <define name="db.function.role.attribute">
|
---|
| 255 | <attribute name="role"/>
|
---|
| 256 | </define>
|
---|
| 257 | <define name="db.function.attlist">
|
---|
| 258 | <interleave>
|
---|
| 259 | <optional>
|
---|
| 260 | <ref name="db.function.role.attribute"/>
|
---|
| 261 | </optional>
|
---|
| 262 | <ref name="db.common.attributes"/>
|
---|
| 263 | <ref name="db.common.linking.attributes"/>
|
---|
| 264 | </interleave>
|
---|
| 265 | </define>
|
---|
| 266 | <define name="db.function">
|
---|
| 267 | <element name="function">
|
---|
| 268 | <ref name="db.function.attlist"/>
|
---|
| 269 | <ref name="db._text"/>
|
---|
| 270 | </element>
|
---|
| 271 | </define>
|
---|
| 272 | </div>
|
---|
| 273 | <!-- ====================================================================== -->
|
---|
| 274 | <div>
|
---|
| 275 | <db:refname>void</db:refname>
|
---|
| 276 | <db:refpurpose>An empty element in a function synopsis indicating that the function in question takes no arguments</db:refpurpose>
|
---|
| 277 | <define name="db.void.role.attribute">
|
---|
| 278 | <attribute name="role"/>
|
---|
| 279 | </define>
|
---|
| 280 | <define name="db.void.attlist">
|
---|
| 281 | <interleave>
|
---|
| 282 | <optional>
|
---|
| 283 | <ref name="db.void.role.attribute"/>
|
---|
| 284 | </optional>
|
---|
| 285 | <ref name="db.common.attributes"/>
|
---|
| 286 | <ref name="db.common.linking.attributes"/>
|
---|
| 287 | </interleave>
|
---|
| 288 | </define>
|
---|
| 289 | <define name="db.void">
|
---|
| 290 | <element name="void">
|
---|
| 291 | <ref name="db.void.attlist"/>
|
---|
| 292 | <empty/>
|
---|
| 293 | </element>
|
---|
| 294 | </define>
|
---|
| 295 | </div>
|
---|
| 296 | <!-- ====================================================================== -->
|
---|
| 297 | <div>
|
---|
| 298 | <db:refname>varargs</db:refname>
|
---|
| 299 | <db:refpurpose>An empty element in a function synopsis indicating a variable number of arguments</db:refpurpose>
|
---|
| 300 | <define name="db.varargs.role.attribute">
|
---|
| 301 | <attribute name="role"/>
|
---|
| 302 | </define>
|
---|
| 303 | <define name="db.varargs.attlist">
|
---|
| 304 | <interleave>
|
---|
| 305 | <optional>
|
---|
| 306 | <ref name="db.varargs.role.attribute"/>
|
---|
| 307 | </optional>
|
---|
| 308 | <ref name="db.common.attributes"/>
|
---|
| 309 | <ref name="db.common.linking.attributes"/>
|
---|
| 310 | </interleave>
|
---|
| 311 | </define>
|
---|
| 312 | <define name="db.varargs">
|
---|
| 313 | <element name="varargs">
|
---|
| 314 | <ref name="db.varargs.attlist"/>
|
---|
| 315 | <empty/>
|
---|
| 316 | </element>
|
---|
| 317 | </define>
|
---|
| 318 | </div>
|
---|
| 319 | <!-- ====================================================================== -->
|
---|
| 320 | <div>
|
---|
| 321 | <db:refname>group</db:refname>
|
---|
| 322 | <db:refpurpose>A group of parameters</db:refpurpose>
|
---|
| 323 | <define name="db.group.paramdef.role.attribute">
|
---|
| 324 | <attribute name="role"/>
|
---|
| 325 | </define>
|
---|
| 326 | <define name="db.group.paramdef.choice.attribute">
|
---|
| 327 | <ref name="db.choice.opt.attribute"/>
|
---|
| 328 | </define>
|
---|
| 329 | <define name="db.group.paramdef.attlist">
|
---|
| 330 | <interleave>
|
---|
| 331 | <optional>
|
---|
| 332 | <ref name="db.group.paramdef.role.attribute"/>
|
---|
| 333 | </optional>
|
---|
| 334 | <ref name="db.common.attributes"/>
|
---|
| 335 | <ref name="db.common.linking.attributes"/>
|
---|
| 336 | <optional>
|
---|
| 337 | <ref name="db.group.paramdef.choice.attribute"/>
|
---|
| 338 | </optional>
|
---|
| 339 | </interleave>
|
---|
| 340 | </define>
|
---|
| 341 | <define name="db.group.paramdef">
|
---|
| 342 | <element name="group">
|
---|
| 343 | <ref name="db.group.paramdef.attlist"/>
|
---|
| 344 | <oneOrMore>
|
---|
| 345 | <choice>
|
---|
| 346 | <ref name="db.paramdef"/>
|
---|
| 347 | <ref name="db.group.paramdef"/>
|
---|
| 348 | </choice>
|
---|
| 349 | </oneOrMore>
|
---|
| 350 | </element>
|
---|
| 351 | </define>
|
---|
| 352 | </div>
|
---|
| 353 | <!-- ====================================================================== -->
|
---|
| 354 | <div>
|
---|
| 355 | <db:refname>paramdef</db:refname>
|
---|
| 356 | <db:refpurpose>Information about a function parameter in a programming language</db:refpurpose>
|
---|
| 357 | <define name="db.paramdef.role.attribute">
|
---|
| 358 | <attribute name="role"/>
|
---|
| 359 | </define>
|
---|
| 360 | <define name="db.paramdef.choice.enumeration">
|
---|
| 361 | <choice>
|
---|
| 362 | <value>opt</value>
|
---|
| 363 | <a:documentation>Formatted to indicate that it is optional.</a:documentation>
|
---|
| 364 | <value>req</value>
|
---|
| 365 | <a:documentation>Formatted to indicate that it is required.</a:documentation>
|
---|
| 366 | </choice>
|
---|
| 367 | </define>
|
---|
| 368 | <define name="db.paramdef.choice.attribute">
|
---|
| 369 | <attribute name="choice" a:defaultValue="opt">
|
---|
| 370 | <db:refpurpose>Indicates optionality.</db:refpurpose>
|
---|
| 371 | <ref name="db.paramdef.choice.enumeration"/>
|
---|
| 372 | </attribute>
|
---|
| 373 | </define>
|
---|
| 374 | <define name="db.paramdef.attlist">
|
---|
| 375 | <interleave>
|
---|
| 376 | <optional>
|
---|
| 377 | <ref name="db.paramdef.role.attribute"/>
|
---|
| 378 | </optional>
|
---|
| 379 | <ref name="db.common.attributes"/>
|
---|
| 380 | <ref name="db.common.linking.attributes"/>
|
---|
| 381 | <optional>
|
---|
| 382 | <ref name="db.paramdef.choice.attribute"/>
|
---|
| 383 | </optional>
|
---|
| 384 | </interleave>
|
---|
| 385 | </define>
|
---|
| 386 | <define name="db.paramdef">
|
---|
| 387 | <element name="paramdef">
|
---|
| 388 | <ref name="db.paramdef.attlist"/>
|
---|
| 389 | <zeroOrMore>
|
---|
| 390 | <choice>
|
---|
| 391 | <ref name="db._text"/>
|
---|
| 392 | <ref name="db.initializer"/>
|
---|
| 393 | <ref name="db.type"/>
|
---|
| 394 | <ref name="db.parameter"/>
|
---|
| 395 | <ref name="db.funcparams"/>
|
---|
| 396 | </choice>
|
---|
| 397 | </zeroOrMore>
|
---|
| 398 | </element>
|
---|
| 399 | </define>
|
---|
| 400 | </div>
|
---|
| 401 | <!-- ====================================================================== -->
|
---|
| 402 | <div>
|
---|
| 403 | <db:refname>funcparams</db:refname>
|
---|
| 404 | <db:refpurpose>Parameters for a function referenced through a function pointer in a synopsis</db:refpurpose>
|
---|
| 405 | <define name="db.funcparams.role.attribute">
|
---|
| 406 | <attribute name="role"/>
|
---|
| 407 | </define>
|
---|
| 408 | <define name="db.funcparams.attlist">
|
---|
| 409 | <interleave>
|
---|
| 410 | <optional>
|
---|
| 411 | <ref name="db.funcparams.role.attribute"/>
|
---|
| 412 | </optional>
|
---|
| 413 | <ref name="db.common.attributes"/>
|
---|
| 414 | <ref name="db.common.linking.attributes"/>
|
---|
| 415 | </interleave>
|
---|
| 416 | </define>
|
---|
| 417 | <define name="db.funcparams">
|
---|
| 418 | <element name="funcparams">
|
---|
| 419 | <ref name="db.funcparams.attlist"/>
|
---|
| 420 | <ref name="db._text"/>
|
---|
| 421 | </element>
|
---|
| 422 | </define>
|
---|
| 423 | </div>
|
---|
| 424 | <!-- ====================================================================== -->
|
---|
| 425 | <div>
|
---|
| 426 | <db:refname>classsynopsis</db:refname>
|
---|
| 427 | <db:refpurpose>The syntax summary for a class definition</db:refpurpose>
|
---|
| 428 | <define name="db.classsynopsis.role.attribute">
|
---|
| 429 | <attribute name="role"/>
|
---|
| 430 | </define>
|
---|
| 431 | <define name="db.classsynopsis.class.enumeration">
|
---|
| 432 | <choice>
|
---|
| 433 | <value>class</value>
|
---|
| 434 | <a:documentation>This is the synopsis of a class</a:documentation>
|
---|
| 435 | <value>interface</value>
|
---|
| 436 | <a:documentation>This is the synopsis of an interface</a:documentation>
|
---|
| 437 | </choice>
|
---|
| 438 | </define>
|
---|
| 439 | <define name="db.classsynopsis.class.attribute">
|
---|
| 440 | <attribute name="class">
|
---|
| 441 | <db:refpurpose>Specifies the nature of the synopsis</db:refpurpose>
|
---|
| 442 | <ref name="db.classsynopsis.class.enumeration"/>
|
---|
| 443 | </attribute>
|
---|
| 444 | </define>
|
---|
| 445 | <define name="db.classsynopsis.attlist">
|
---|
| 446 | <interleave>
|
---|
| 447 | <optional>
|
---|
| 448 | <ref name="db.classsynopsis.role.attribute"/>
|
---|
| 449 | </optional>
|
---|
| 450 | <ref name="db.common.attributes"/>
|
---|
| 451 | <ref name="db.common.linking.attributes"/>
|
---|
| 452 | <optional>
|
---|
| 453 | <ref name="db.language.attribute"/>
|
---|
| 454 | </optional>
|
---|
| 455 | <optional>
|
---|
| 456 | <ref name="db.classsynopsis.class.attribute"/>
|
---|
| 457 | </optional>
|
---|
| 458 | </interleave>
|
---|
| 459 | </define>
|
---|
| 460 | <define name="db.classsynopsis">
|
---|
| 461 | <element name="classsynopsis">
|
---|
| 462 | <ref name="db.classsynopsis.attlist"/>
|
---|
| 463 | <oneOrMore>
|
---|
| 464 | <ref name="db.oo.inlines"/>
|
---|
| 465 | </oneOrMore>
|
---|
| 466 | <zeroOrMore>
|
---|
| 467 | <choice>
|
---|
| 468 | <ref name="db.classsynopsisinfo"/>
|
---|
| 469 | <ref name="db.methodsynopsis"/>
|
---|
| 470 | <ref name="db.constructorsynopsis"/>
|
---|
| 471 | <ref name="db.destructorsynopsis"/>
|
---|
| 472 | <ref name="db.fieldsynopsis"/>
|
---|
| 473 | </choice>
|
---|
| 474 | </zeroOrMore>
|
---|
| 475 | </element>
|
---|
| 476 | </define>
|
---|
| 477 | </div>
|
---|
| 478 | <!-- ====================================================================== -->
|
---|
| 479 | <div>
|
---|
| 480 | <db:refname>classsynopsisinfo</db:refname>
|
---|
| 481 | <db:refpurpose>Information supplementing the contents of a classsynopsis</db:refpurpose>
|
---|
| 482 | <define name="db.classsynopsisinfo.role.attribute">
|
---|
| 483 | <attribute name="role"/>
|
---|
| 484 | </define>
|
---|
| 485 | <define name="db.classsynopsisinfo.attlist">
|
---|
| 486 | <interleave>
|
---|
| 487 | <optional>
|
---|
| 488 | <ref name="db.classsynopsisinfo.role.attribute"/>
|
---|
| 489 | </optional>
|
---|
| 490 | <ref name="db.common.attributes"/>
|
---|
| 491 | <ref name="db.common.linking.attributes"/>
|
---|
| 492 | <ref name="db.verbatim.attributes"/>
|
---|
| 493 | </interleave>
|
---|
| 494 | </define>
|
---|
| 495 | <define name="db.classsynopsisinfo">
|
---|
| 496 | <element name="classsynopsisinfo">
|
---|
| 497 | <ref name="db.classsynopsisinfo.attlist"/>
|
---|
| 498 | <ref name="db.verbatim.contentmodel"/>
|
---|
| 499 | </element>
|
---|
| 500 | </define>
|
---|
| 501 | </div>
|
---|
| 502 | <!-- ====================================================================== -->
|
---|
| 503 | <div>
|
---|
| 504 | <db:refname>ooclass</db:refname>
|
---|
| 505 | <db:refpurpose>A class in an object-oriented programming language</db:refpurpose>
|
---|
| 506 | <define name="db.ooclass.role.attribute">
|
---|
| 507 | <attribute name="role"/>
|
---|
| 508 | </define>
|
---|
| 509 | <define name="db.ooclass.attlist">
|
---|
| 510 | <interleave>
|
---|
| 511 | <optional>
|
---|
| 512 | <ref name="db.ooclass.role.attribute"/>
|
---|
| 513 | </optional>
|
---|
| 514 | <ref name="db.common.attributes"/>
|
---|
| 515 | <ref name="db.common.linking.attributes"/>
|
---|
| 516 | </interleave>
|
---|
| 517 | </define>
|
---|
| 518 | <define name="db.ooclass">
|
---|
| 519 | <element name="ooclass">
|
---|
| 520 | <ref name="db.ooclass.attlist"/>
|
---|
| 521 | <zeroOrMore>
|
---|
| 522 | <choice>
|
---|
| 523 | <ref name="db.package"/>
|
---|
| 524 | <ref name="db.modifier"/>
|
---|
| 525 | </choice>
|
---|
| 526 | </zeroOrMore>
|
---|
| 527 | <ref name="db.classname"/>
|
---|
| 528 | </element>
|
---|
| 529 | </define>
|
---|
| 530 | </div>
|
---|
| 531 | <!-- ====================================================================== -->
|
---|
| 532 | <div>
|
---|
| 533 | <db:refname>oointerface</db:refname>
|
---|
| 534 | <db:refpurpose>An interface in an object-oriented programming language</db:refpurpose>
|
---|
| 535 | <define name="db.oointerface.role.attribute">
|
---|
| 536 | <attribute name="role"/>
|
---|
| 537 | </define>
|
---|
| 538 | <define name="db.oointerface.attlist">
|
---|
| 539 | <interleave>
|
---|
| 540 | <optional>
|
---|
| 541 | <ref name="db.oointerface.role.attribute"/>
|
---|
| 542 | </optional>
|
---|
| 543 | <ref name="db.common.attributes"/>
|
---|
| 544 | <ref name="db.common.linking.attributes"/>
|
---|
| 545 | </interleave>
|
---|
| 546 | </define>
|
---|
| 547 | <define name="db.oointerface">
|
---|
| 548 | <element name="oointerface">
|
---|
| 549 | <ref name="db.oointerface.attlist"/>
|
---|
| 550 | <zeroOrMore>
|
---|
| 551 | <choice>
|
---|
| 552 | <ref name="db.package"/>
|
---|
| 553 | <ref name="db.modifier"/>
|
---|
| 554 | </choice>
|
---|
| 555 | </zeroOrMore>
|
---|
| 556 | <ref name="db.interfacename"/>
|
---|
| 557 | </element>
|
---|
| 558 | </define>
|
---|
| 559 | </div>
|
---|
| 560 | <!-- ====================================================================== -->
|
---|
| 561 | <div>
|
---|
| 562 | <db:refname>ooexception</db:refname>
|
---|
| 563 | <db:refpurpose>An exception in an object-oriented programming language</db:refpurpose>
|
---|
| 564 | <define name="db.ooexception.role.attribute">
|
---|
| 565 | <attribute name="role"/>
|
---|
| 566 | </define>
|
---|
| 567 | <define name="db.ooexception.attlist">
|
---|
| 568 | <interleave>
|
---|
| 569 | <optional>
|
---|
| 570 | <ref name="db.ooexception.role.attribute"/>
|
---|
| 571 | </optional>
|
---|
| 572 | <ref name="db.common.attributes"/>
|
---|
| 573 | <ref name="db.common.linking.attributes"/>
|
---|
| 574 | </interleave>
|
---|
| 575 | </define>
|
---|
| 576 | <define name="db.ooexception">
|
---|
| 577 | <element name="ooexception">
|
---|
| 578 | <ref name="db.ooexception.attlist"/>
|
---|
| 579 | <zeroOrMore>
|
---|
| 580 | <choice>
|
---|
| 581 | <ref name="db.package"/>
|
---|
| 582 | <ref name="db.modifier"/>
|
---|
| 583 | </choice>
|
---|
| 584 | </zeroOrMore>
|
---|
| 585 | <ref name="db.exceptionname"/>
|
---|
| 586 | </element>
|
---|
| 587 | </define>
|
---|
| 588 | </div>
|
---|
| 589 | <!-- ====================================================================== -->
|
---|
| 590 | <define name="db.modifier.xml.space.attribute">
|
---|
| 591 | <attribute name="xml:space">
|
---|
| 592 | <db:refpurpose>Can be used to indicate that whitespace in the modifier should be preserved (for multi-line annotations, for example).</db:refpurpose>
|
---|
| 593 | <value>preserve</value>
|
---|
| 594 | <a:documentation>Extra whitespace and line breaks must be preserved.</a:documentation>
|
---|
| 595 | <!--
|
---|
| 596 | Ideally the definition of xml:space used on modifier would be
|
---|
| 597 | different from the definition used on the verbatim elements. The
|
---|
| 598 | verbatim elements forbid the use of xml:space="default" which
|
---|
| 599 | wouldn't be a problem on modifier. But doing that causes the
|
---|
| 600 | generated XSD schemas to be broken so I'm just reusing the existing
|
---|
| 601 | definition for now. It won't be backwards incompatible to fix this
|
---|
| 602 | problem in the future.
|
---|
| 603 | | ## Extra whitespace and line breaks are not preserved.
|
---|
| 604 | "default"
|
---|
| 605 | -->
|
---|
| 606 | </attribute>
|
---|
| 607 | </define>
|
---|
| 608 | <div>
|
---|
| 609 | <db:refname>modifier</db:refname>
|
---|
| 610 | <db:refpurpose>Modifiers in a synopsis</db:refpurpose>
|
---|
| 611 | <define name="db.modifier.role.attribute">
|
---|
| 612 | <attribute name="role"/>
|
---|
| 613 | </define>
|
---|
| 614 | <define name="db.modifier.attlist">
|
---|
| 615 | <interleave>
|
---|
| 616 | <optional>
|
---|
| 617 | <ref name="db.modifier.xml.space.attribute"/>
|
---|
| 618 | </optional>
|
---|
| 619 | <optional>
|
---|
| 620 | <ref name="db.modifier.role.attribute"/>
|
---|
| 621 | </optional>
|
---|
| 622 | <ref name="db.common.attributes"/>
|
---|
| 623 | <ref name="db.common.linking.attributes"/>
|
---|
| 624 | </interleave>
|
---|
| 625 | </define>
|
---|
| 626 | <define name="db.modifier">
|
---|
| 627 | <element name="modifier">
|
---|
| 628 | <ref name="db.modifier.attlist"/>
|
---|
| 629 | <ref name="db._text"/>
|
---|
| 630 | </element>
|
---|
| 631 | </define>
|
---|
| 632 | </div>
|
---|
| 633 | <!-- ====================================================================== -->
|
---|
| 634 | <div>
|
---|
| 635 | <db:refname>interfacename</db:refname>
|
---|
| 636 | <db:refpurpose>The name of an interface</db:refpurpose>
|
---|
| 637 | <define name="db.interfacename.role.attribute">
|
---|
| 638 | <attribute name="role"/>
|
---|
| 639 | </define>
|
---|
| 640 | <define name="db.interfacename.attlist">
|
---|
| 641 | <interleave>
|
---|
| 642 | <optional>
|
---|
| 643 | <ref name="db.interfacename.role.attribute"/>
|
---|
| 644 | </optional>
|
---|
| 645 | <ref name="db.common.attributes"/>
|
---|
| 646 | <ref name="db.common.linking.attributes"/>
|
---|
| 647 | </interleave>
|
---|
| 648 | </define>
|
---|
| 649 | <define name="db.interfacename">
|
---|
| 650 | <element name="interfacename">
|
---|
| 651 | <ref name="db.interfacename.attlist"/>
|
---|
| 652 | <ref name="db._text"/>
|
---|
| 653 | </element>
|
---|
| 654 | </define>
|
---|
| 655 | </div>
|
---|
| 656 | <!-- ====================================================================== -->
|
---|
| 657 | <div>
|
---|
| 658 | <db:refname>exceptionname</db:refname>
|
---|
| 659 | <db:refpurpose>The name of an exception</db:refpurpose>
|
---|
| 660 | <define name="db.exceptionname.role.attribute">
|
---|
| 661 | <attribute name="role"/>
|
---|
| 662 | </define>
|
---|
| 663 | <define name="db.exceptionname.attlist">
|
---|
| 664 | <interleave>
|
---|
| 665 | <optional>
|
---|
| 666 | <ref name="db.exceptionname.role.attribute"/>
|
---|
| 667 | </optional>
|
---|
| 668 | <ref name="db.common.attributes"/>
|
---|
| 669 | <ref name="db.common.linking.attributes"/>
|
---|
| 670 | </interleave>
|
---|
| 671 | </define>
|
---|
| 672 | <define name="db.exceptionname">
|
---|
| 673 | <element name="exceptionname">
|
---|
| 674 | <ref name="db.exceptionname.attlist"/>
|
---|
| 675 | <ref name="db._text"/>
|
---|
| 676 | </element>
|
---|
| 677 | </define>
|
---|
| 678 | </div>
|
---|
| 679 | <!-- ====================================================================== -->
|
---|
| 680 | <div>
|
---|
| 681 | <db:refname>fieldsynopsis</db:refname>
|
---|
| 682 | <db:refpurpose>The name of a field in a class definition</db:refpurpose>
|
---|
| 683 | <define name="db.fieldsynopsis.role.attribute">
|
---|
| 684 | <attribute name="role"/>
|
---|
| 685 | </define>
|
---|
| 686 | <define name="db.fieldsynopsis.attlist">
|
---|
| 687 | <interleave>
|
---|
| 688 | <optional>
|
---|
| 689 | <ref name="db.fieldsynopsis.role.attribute"/>
|
---|
| 690 | </optional>
|
---|
| 691 | <ref name="db.common.attributes"/>
|
---|
| 692 | <ref name="db.common.linking.attributes"/>
|
---|
| 693 | <optional>
|
---|
| 694 | <ref name="db.language.attribute"/>
|
---|
| 695 | </optional>
|
---|
| 696 | </interleave>
|
---|
| 697 | </define>
|
---|
| 698 | <define name="db.fieldsynopsis">
|
---|
| 699 | <element name="fieldsynopsis">
|
---|
| 700 | <ref name="db.fieldsynopsis.attlist"/>
|
---|
| 701 | <zeroOrMore>
|
---|
| 702 | <ref name="db.modifier"/>
|
---|
| 703 | </zeroOrMore>
|
---|
| 704 | <optional>
|
---|
| 705 | <ref name="db.type"/>
|
---|
| 706 | </optional>
|
---|
| 707 | <ref name="db.varname"/>
|
---|
| 708 | <optional>
|
---|
| 709 | <ref name="db.initializer"/>
|
---|
| 710 | </optional>
|
---|
| 711 | </element>
|
---|
| 712 | </define>
|
---|
| 713 | </div>
|
---|
| 714 | <!-- ====================================================================== -->
|
---|
| 715 | <div>
|
---|
| 716 | <db:refname>initializer</db:refname>
|
---|
| 717 | <db:refpurpose>The initializer for a fieldsynopsis</db:refpurpose>
|
---|
| 718 | <define name="db.initializer.role.attribute">
|
---|
| 719 | <attribute name="role"/>
|
---|
| 720 | </define>
|
---|
| 721 | <define name="db.initializer.attlist">
|
---|
| 722 | <interleave>
|
---|
| 723 | <optional>
|
---|
| 724 | <ref name="db.initializer.role.attribute"/>
|
---|
| 725 | </optional>
|
---|
| 726 | <ref name="db.common.attributes"/>
|
---|
| 727 | <ref name="db.common.linking.attributes"/>
|
---|
| 728 | </interleave>
|
---|
| 729 | </define>
|
---|
| 730 | <define name="db.initializer.inlines">
|
---|
| 731 | <ref name="db._text"/>
|
---|
| 732 | </define>
|
---|
| 733 | <define name="db.initializer">
|
---|
| 734 | <element name="initializer">
|
---|
| 735 | <ref name="db.initializer.attlist"/>
|
---|
| 736 | <zeroOrMore>
|
---|
| 737 | <ref name="db.initializer.inlines"/>
|
---|
| 738 | </zeroOrMore>
|
---|
| 739 | </element>
|
---|
| 740 | </define>
|
---|
| 741 | </div>
|
---|
| 742 | <!-- ====================================================================== -->
|
---|
| 743 | <div>
|
---|
| 744 | <db:refname>constructorsynopsis</db:refname>
|
---|
| 745 | <db:refpurpose>A syntax summary for a constructor</db:refpurpose>
|
---|
| 746 | <define name="db.constructorsynopsis.role.attribute">
|
---|
| 747 | <attribute name="role"/>
|
---|
| 748 | </define>
|
---|
| 749 | <define name="db.constructorsynopsis.attlist">
|
---|
| 750 | <interleave>
|
---|
| 751 | <optional>
|
---|
| 752 | <ref name="db.constructorsynopsis.role.attribute"/>
|
---|
| 753 | </optional>
|
---|
| 754 | <ref name="db.common.attributes"/>
|
---|
| 755 | <ref name="db.common.linking.attributes"/>
|
---|
| 756 | <optional>
|
---|
| 757 | <ref name="db.language.attribute"/>
|
---|
| 758 | </optional>
|
---|
| 759 | </interleave>
|
---|
| 760 | </define>
|
---|
| 761 | <define name="db.constructorsynopsis">
|
---|
| 762 | <element name="constructorsynopsis">
|
---|
| 763 | <ref name="db.constructorsynopsis.attlist"/>
|
---|
| 764 | <zeroOrMore>
|
---|
| 765 | <ref name="db.modifier"/>
|
---|
| 766 | </zeroOrMore>
|
---|
| 767 | <optional>
|
---|
| 768 | <ref name="db.methodname"/>
|
---|
| 769 | </optional>
|
---|
| 770 | <choice>
|
---|
| 771 | <oneOrMore>
|
---|
| 772 | <choice>
|
---|
| 773 | <ref name="db.methodparam"/>
|
---|
| 774 | <ref name="db.group.methodparam"/>
|
---|
| 775 | </choice>
|
---|
| 776 | </oneOrMore>
|
---|
| 777 | <optional>
|
---|
| 778 | <ref name="db.void"/>
|
---|
| 779 | </optional>
|
---|
| 780 | </choice>
|
---|
| 781 | <zeroOrMore>
|
---|
| 782 | <ref name="db.exceptionname"/>
|
---|
| 783 | </zeroOrMore>
|
---|
| 784 | </element>
|
---|
| 785 | </define>
|
---|
| 786 | </div>
|
---|
| 787 | <!-- ====================================================================== -->
|
---|
| 788 | <div>
|
---|
| 789 | <db:refname>destructorsynopsis</db:refname>
|
---|
| 790 | <db:refpurpose>A syntax summary for a destructor</db:refpurpose>
|
---|
| 791 | <define name="db.destructorsynopsis.role.attribute">
|
---|
| 792 | <attribute name="role"/>
|
---|
| 793 | </define>
|
---|
| 794 | <define name="db.destructorsynopsis.attlist">
|
---|
| 795 | <interleave>
|
---|
| 796 | <optional>
|
---|
| 797 | <ref name="db.destructorsynopsis.role.attribute"/>
|
---|
| 798 | </optional>
|
---|
| 799 | <ref name="db.common.attributes"/>
|
---|
| 800 | <ref name="db.common.linking.attributes"/>
|
---|
| 801 | <optional>
|
---|
| 802 | <ref name="db.language.attribute"/>
|
---|
| 803 | </optional>
|
---|
| 804 | </interleave>
|
---|
| 805 | </define>
|
---|
| 806 | <define name="db.destructorsynopsis">
|
---|
| 807 | <element name="destructorsynopsis">
|
---|
| 808 | <ref name="db.destructorsynopsis.attlist"/>
|
---|
| 809 | <zeroOrMore>
|
---|
| 810 | <ref name="db.modifier"/>
|
---|
| 811 | </zeroOrMore>
|
---|
| 812 | <optional>
|
---|
| 813 | <ref name="db.methodname"/>
|
---|
| 814 | </optional>
|
---|
| 815 | <choice>
|
---|
| 816 | <oneOrMore>
|
---|
| 817 | <choice>
|
---|
| 818 | <ref name="db.methodparam"/>
|
---|
| 819 | <ref name="db.group.methodparam"/>
|
---|
| 820 | </choice>
|
---|
| 821 | </oneOrMore>
|
---|
| 822 | <optional>
|
---|
| 823 | <ref name="db.void"/>
|
---|
| 824 | </optional>
|
---|
| 825 | </choice>
|
---|
| 826 | <zeroOrMore>
|
---|
| 827 | <ref name="db.exceptionname"/>
|
---|
| 828 | </zeroOrMore>
|
---|
| 829 | </element>
|
---|
| 830 | </define>
|
---|
| 831 | </div>
|
---|
| 832 | <!-- ====================================================================== -->
|
---|
| 833 | <div>
|
---|
| 834 | <db:refname>methodsynopsis</db:refname>
|
---|
| 835 | <db:refpurpose>A syntax summary for a method</db:refpurpose>
|
---|
| 836 | <define name="db.methodsynopsis.role.attribute">
|
---|
| 837 | <attribute name="role"/>
|
---|
| 838 | </define>
|
---|
| 839 | <define name="db.methodsynopsis.attlist">
|
---|
| 840 | <interleave>
|
---|
| 841 | <optional>
|
---|
| 842 | <ref name="db.methodsynopsis.role.attribute"/>
|
---|
| 843 | </optional>
|
---|
| 844 | <ref name="db.common.attributes"/>
|
---|
| 845 | <ref name="db.common.linking.attributes"/>
|
---|
| 846 | <optional>
|
---|
| 847 | <ref name="db.language.attribute"/>
|
---|
| 848 | </optional>
|
---|
| 849 | </interleave>
|
---|
| 850 | </define>
|
---|
| 851 | <define name="db.methodsynopsis">
|
---|
| 852 | <element name="methodsynopsis">
|
---|
| 853 | <ref name="db.methodsynopsis.attlist"/>
|
---|
| 854 | <zeroOrMore>
|
---|
| 855 | <ref name="db.modifier"/>
|
---|
| 856 | </zeroOrMore>
|
---|
| 857 | <optional>
|
---|
| 858 | <choice>
|
---|
| 859 | <ref name="db.type"/>
|
---|
| 860 | <ref name="db.void"/>
|
---|
| 861 | </choice>
|
---|
| 862 | </optional>
|
---|
| 863 | <ref name="db.methodname"/>
|
---|
| 864 | <choice>
|
---|
| 865 | <oneOrMore>
|
---|
| 866 | <choice>
|
---|
| 867 | <ref name="db.methodparam"/>
|
---|
| 868 | <ref name="db.group.methodparam"/>
|
---|
| 869 | </choice>
|
---|
| 870 | </oneOrMore>
|
---|
| 871 | <ref name="db.void"/>
|
---|
| 872 | </choice>
|
---|
| 873 | <zeroOrMore>
|
---|
| 874 | <ref name="db.exceptionname"/>
|
---|
| 875 | </zeroOrMore>
|
---|
| 876 | <zeroOrMore>
|
---|
| 877 | <ref name="db.modifier"/>
|
---|
| 878 | </zeroOrMore>
|
---|
| 879 | </element>
|
---|
| 880 | </define>
|
---|
| 881 | </div>
|
---|
| 882 | <!-- ====================================================================== -->
|
---|
| 883 | <div>
|
---|
| 884 | <db:refname>methodname</db:refname>
|
---|
| 885 | <db:refpurpose>The name of a method</db:refpurpose>
|
---|
| 886 | <define name="db.methodname.role.attribute">
|
---|
| 887 | <attribute name="role"/>
|
---|
| 888 | </define>
|
---|
| 889 | <define name="db.methodname.attlist">
|
---|
| 890 | <interleave>
|
---|
| 891 | <optional>
|
---|
| 892 | <ref name="db.methodname.role.attribute"/>
|
---|
| 893 | </optional>
|
---|
| 894 | <ref name="db.common.attributes"/>
|
---|
| 895 | <ref name="db.common.linking.attributes"/>
|
---|
| 896 | </interleave>
|
---|
| 897 | </define>
|
---|
| 898 | <define name="db.methodname">
|
---|
| 899 | <element name="methodname">
|
---|
| 900 | <ref name="db.methodname.attlist"/>
|
---|
| 901 | <ref name="db._text"/>
|
---|
| 902 | </element>
|
---|
| 903 | </define>
|
---|
| 904 | </div>
|
---|
| 905 | <!-- ====================================================================== -->
|
---|
| 906 | <div>
|
---|
| 907 | <db:refname>methodparam</db:refname>
|
---|
| 908 | <db:refpurpose>Parameters to a method</db:refpurpose>
|
---|
| 909 | <define name="db.methodparam.role.attribute">
|
---|
| 910 | <attribute name="role"/>
|
---|
| 911 | </define>
|
---|
| 912 | <define name="db.methodparam.rep.attribute">
|
---|
| 913 | <ref name="db.rep.attribute"/>
|
---|
| 914 | </define>
|
---|
| 915 | <define name="db.methodparam.choice.attribute">
|
---|
| 916 | <ref name="db.choice.req.attribute"/>
|
---|
| 917 | </define>
|
---|
| 918 | <define name="db.methodparam.attlist">
|
---|
| 919 | <interleave>
|
---|
| 920 | <optional>
|
---|
| 921 | <ref name="db.methodparam.role.attribute"/>
|
---|
| 922 | </optional>
|
---|
| 923 | <ref name="db.common.attributes"/>
|
---|
| 924 | <ref name="db.common.linking.attributes"/>
|
---|
| 925 | <optional>
|
---|
| 926 | <ref name="db.methodparam.rep.attribute"/>
|
---|
| 927 | </optional>
|
---|
| 928 | <optional>
|
---|
| 929 | <ref name="db.methodparam.choice.attribute"/>
|
---|
| 930 | </optional>
|
---|
| 931 | </interleave>
|
---|
| 932 | </define>
|
---|
| 933 | <define name="db.methodparam">
|
---|
| 934 | <element name="methodparam">
|
---|
| 935 | <ref name="db.methodparam.attlist"/>
|
---|
| 936 | <zeroOrMore>
|
---|
| 937 | <ref name="db.modifier"/>
|
---|
| 938 | </zeroOrMore>
|
---|
| 939 | <optional>
|
---|
| 940 | <ref name="db.type"/>
|
---|
| 941 | </optional>
|
---|
| 942 | <choice>
|
---|
| 943 | <group>
|
---|
| 944 | <zeroOrMore>
|
---|
| 945 | <ref name="db.modifier"/>
|
---|
| 946 | </zeroOrMore>
|
---|
| 947 | <ref name="db.parameter"/>
|
---|
| 948 | <optional>
|
---|
| 949 | <ref name="db.initializer"/>
|
---|
| 950 | </optional>
|
---|
| 951 | </group>
|
---|
| 952 | <ref name="db.funcparams"/>
|
---|
| 953 | </choice>
|
---|
| 954 | <zeroOrMore>
|
---|
| 955 | <ref name="db.modifier"/>
|
---|
| 956 | </zeroOrMore>
|
---|
| 957 | </element>
|
---|
| 958 | </define>
|
---|
| 959 | </div>
|
---|
| 960 | <!-- ====================================================================== -->
|
---|
| 961 | <div>
|
---|
| 962 | <db:refname>group</db:refname>
|
---|
| 963 | <db:refpurpose>A group of method parameters</db:refpurpose>
|
---|
| 964 | <define name="db.group.methodparam.role.attribute">
|
---|
| 965 | <attribute name="role"/>
|
---|
| 966 | </define>
|
---|
| 967 | <define name="db.group.methodparam.choice.attribute">
|
---|
| 968 | <ref name="db.choice.opt.attribute"/>
|
---|
| 969 | </define>
|
---|
| 970 | <define name="db.group.methodparam.attlist">
|
---|
| 971 | <interleave>
|
---|
| 972 | <optional>
|
---|
| 973 | <ref name="db.group.methodparam.role.attribute"/>
|
---|
| 974 | </optional>
|
---|
| 975 | <ref name="db.common.attributes"/>
|
---|
| 976 | <ref name="db.common.linking.attributes"/>
|
---|
| 977 | <optional>
|
---|
| 978 | <ref name="db.group.methodparam.choice.attribute"/>
|
---|
| 979 | </optional>
|
---|
| 980 | </interleave>
|
---|
| 981 | </define>
|
---|
| 982 | <define name="db.group.methodparam">
|
---|
| 983 | <element name="group">
|
---|
| 984 | <ref name="db.group.methodparam.attlist"/>
|
---|
| 985 | <oneOrMore>
|
---|
| 986 | <choice>
|
---|
| 987 | <ref name="db.methodparam"/>
|
---|
| 988 | <ref name="db.group.methodparam"/>
|
---|
| 989 | </choice>
|
---|
| 990 | </oneOrMore>
|
---|
| 991 | </element>
|
---|
| 992 | </define>
|
---|
| 993 | </div>
|
---|
| 994 | <!-- ====================================================================== -->
|
---|
| 995 | <div>
|
---|
| 996 | <db:refname>varname</db:refname>
|
---|
| 997 | <db:refpurpose>The name of a variable</db:refpurpose>
|
---|
| 998 | <define name="db.varname.role.attribute">
|
---|
| 999 | <attribute name="role"/>
|
---|
| 1000 | </define>
|
---|
| 1001 | <define name="db.varname.attlist">
|
---|
| 1002 | <interleave>
|
---|
| 1003 | <optional>
|
---|
| 1004 | <ref name="db.varname.role.attribute"/>
|
---|
| 1005 | </optional>
|
---|
| 1006 | <ref name="db.common.attributes"/>
|
---|
| 1007 | <ref name="db.common.linking.attributes"/>
|
---|
| 1008 | </interleave>
|
---|
| 1009 | </define>
|
---|
| 1010 | <define name="db.varname">
|
---|
| 1011 | <element name="varname">
|
---|
| 1012 | <ref name="db.varname.attlist"/>
|
---|
| 1013 | <ref name="db._text"/>
|
---|
| 1014 | </element>
|
---|
| 1015 | </define>
|
---|
| 1016 | </div>
|
---|
| 1017 | <!-- ====================================================================== -->
|
---|
| 1018 | <div>
|
---|
| 1019 | <db:refname>returnvalue</db:refname>
|
---|
| 1020 | <db:refpurpose>The value returned by a function</db:refpurpose>
|
---|
| 1021 | <define name="db.returnvalue.role.attribute">
|
---|
| 1022 | <attribute name="role"/>
|
---|
| 1023 | </define>
|
---|
| 1024 | <define name="db.returnvalue.attlist">
|
---|
| 1025 | <interleave>
|
---|
| 1026 | <optional>
|
---|
| 1027 | <ref name="db.returnvalue.role.attribute"/>
|
---|
| 1028 | </optional>
|
---|
| 1029 | <ref name="db.common.attributes"/>
|
---|
| 1030 | <ref name="db.common.linking.attributes"/>
|
---|
| 1031 | </interleave>
|
---|
| 1032 | </define>
|
---|
| 1033 | <define name="db.returnvalue">
|
---|
| 1034 | <element name="returnvalue">
|
---|
| 1035 | <ref name="db.returnvalue.attlist"/>
|
---|
| 1036 | <ref name="db._text"/>
|
---|
| 1037 | </element>
|
---|
| 1038 | </define>
|
---|
| 1039 | </div>
|
---|
| 1040 | <!-- ====================================================================== -->
|
---|
| 1041 | <div>
|
---|
| 1042 | <db:refname>type</db:refname>
|
---|
| 1043 | <db:refpurpose>The classification of a value</db:refpurpose>
|
---|
| 1044 | <define name="db.type.role.attribute">
|
---|
| 1045 | <attribute name="role"/>
|
---|
| 1046 | </define>
|
---|
| 1047 | <define name="db.type.attlist">
|
---|
| 1048 | <interleave>
|
---|
| 1049 | <optional>
|
---|
| 1050 | <ref name="db.type.role.attribute"/>
|
---|
| 1051 | </optional>
|
---|
| 1052 | <ref name="db.common.attributes"/>
|
---|
| 1053 | <ref name="db.common.linking.attributes"/>
|
---|
| 1054 | </interleave>
|
---|
| 1055 | </define>
|
---|
| 1056 | <define name="db.type">
|
---|
| 1057 | <element name="type">
|
---|
| 1058 | <ref name="db.type.attlist"/>
|
---|
| 1059 | <ref name="db._text"/>
|
---|
| 1060 | </element>
|
---|
| 1061 | </define>
|
---|
| 1062 | </div>
|
---|
| 1063 | <!-- ====================================================================== -->
|
---|
| 1064 | <div>
|
---|
| 1065 | <db:refname>classname</db:refname>
|
---|
| 1066 | <db:refpurpose>The name of a class, in the object-oriented programming sense</db:refpurpose>
|
---|
| 1067 | <define name="db.classname.role.attribute">
|
---|
| 1068 | <attribute name="role"/>
|
---|
| 1069 | </define>
|
---|
| 1070 | <define name="db.classname.attlist">
|
---|
| 1071 | <interleave>
|
---|
| 1072 | <optional>
|
---|
| 1073 | <ref name="db.classname.role.attribute"/>
|
---|
| 1074 | </optional>
|
---|
| 1075 | <ref name="db.common.attributes"/>
|
---|
| 1076 | <ref name="db.common.linking.attributes"/>
|
---|
| 1077 | </interleave>
|
---|
| 1078 | </define>
|
---|
| 1079 | <define name="db.classname">
|
---|
| 1080 | <element name="classname">
|
---|
| 1081 | <ref name="db.classname.attlist"/>
|
---|
| 1082 | <ref name="db._text"/>
|
---|
| 1083 | </element>
|
---|
| 1084 | </define>
|
---|
| 1085 | </div>
|
---|
| 1086 | <!-- ====================================================================== -->
|
---|
| 1087 | <div>
|
---|
| 1088 | <db:refname>programlisting</db:refname>
|
---|
| 1089 | <db:refpurpose>A literal listing of all or part of a program</db:refpurpose>
|
---|
| 1090 | <define name="db.programlisting.role.attribute">
|
---|
| 1091 | <attribute name="role"/>
|
---|
| 1092 | </define>
|
---|
| 1093 | <define name="db.programlisting.width.attribute">
|
---|
| 1094 | <ref name="db.width.characters.attribute"/>
|
---|
| 1095 | </define>
|
---|
| 1096 | <define name="db.programlisting.attlist">
|
---|
| 1097 | <interleave>
|
---|
| 1098 | <optional>
|
---|
| 1099 | <ref name="db.programlisting.role.attribute"/>
|
---|
| 1100 | </optional>
|
---|
| 1101 | <ref name="db.common.attributes"/>
|
---|
| 1102 | <ref name="db.common.linking.attributes"/>
|
---|
| 1103 | <ref name="db.verbatim.attributes"/>
|
---|
| 1104 | <optional>
|
---|
| 1105 | <ref name="db.programlisting.width.attribute"/>
|
---|
| 1106 | </optional>
|
---|
| 1107 | </interleave>
|
---|
| 1108 | </define>
|
---|
| 1109 | <define name="db.programlisting">
|
---|
| 1110 | <element name="programlisting">
|
---|
| 1111 | <ref name="db.programlisting.attlist"/>
|
---|
| 1112 | <ref name="db.verbatim.contentmodel"/>
|
---|
| 1113 | </element>
|
---|
| 1114 | </define>
|
---|
| 1115 | </div>
|
---|
| 1116 | </grammar>
|
---|