1 <!-- =====================================================================
3 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 Copyright 2008 by Sun Microsystems, Inc.
7 OpenOffice.org - a multi-platform office productivity suite
9 $RCSfile: ApiSymbols.dtd,v $
13 This file is part of OpenOffice.org.
15 OpenOffice.org is free software: you can redistribute it and/or modify
16 it under the terms of the GNU Lesser General Public License version 3
17 only, as published by the Free Software Foundation.
19 OpenOffice.org is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 GNU Lesser General Public License version 3 for more details
23 (a copy is included in the LICENSE file that accompanied this code).
25 You should have received a copy of the GNU Lesser General Public License
26 version 3 along with OpenOffice.org. If not, see
27 <http://www.openoffice.org/license.html>
28 for a copy of the LGPLv3 License.
30 ====================================================================== -->
32 <!ELEMENT api (element)+
>
34 library-name CDATA #REQUIRED
35 library-identifier CDATA #REQUIRED
36 library-majorversion CDATA #IMPLIED
37 library-minorversion CDATA #IMPLIED
38 library-type CDATA #IMPLIED
39 library-GUID CDATA #IMPLIED
40 library-filename CDATA #IMPLIED
41 author CDATA #REQUIRED
42 date-created CDATA #REQUIRED
45 <!ELEMENT element (source, destination?)
>
47 type (class|method|property|enumeration|constant|event) #REQUIRED
48 collection (true|false)
"false"
49 platform CDATA #IMPLIED
52 <!ELEMENT source (context?, name?, type?, value?, parameter-list?)
>
55 start-index CDATA #IMPLIED
58 <!ELEMENT context (#PCDATA)
>
60 kind (library|class|module|enumeration) #REQUIRED
63 <!ELEMENT name (#PCDATA)
>
65 default (true|false)
"false"
68 <!ELEMENT type (#PCDATA | choice)*
>
73 <!ELEMENT choice (#PCDATA)
>
75 <!ELEMENT value (#PCDATA)
>
77 <!ELEMENT parameter-list (parameter+)
>
79 <!ELEMENT parameter (type?, name)
>
81 optional (true|false)
"false"
82 reference (true|false)
"false"
85 <!ELEMENT destination (((inplace-code | property-access-code), localdecl-code*, module-code*, comment*)?)
>
86 <!ATTLIST destination designation (identity|not-yet-implemented)
"not-yet-implemented">
88 <!ELEMENT inplace-code (context-code? , name-code, parameter-code*)
>
90 <!ELEMENT context-code EMPTY
>
92 <!ELEMENT name-code (#PCDATA)
>
94 <!ELEMENT parameter-code (#PCDATA | context-code | rvalue-code | default-code)*
>
96 <!ELEMENT rvalue-code EMPTY
>
98 <!ELEMENT default-code (#PCDATA)
>
100 <!ELEMENT property-access-code (getter-code?, setter-code?)
>
102 <!ELEMENT getter-code (context-code? , name-code, parameter-code*)
>
104 <!ELEMENT module-code (#PCDATA)
>
105 <!ATTLIST module-code
106 module-name CDATA #IMPLIED
108 <!ELEMENT comment (#PCDATA)
>
110 apistatus (todo|so7|so8|noapi) #REQUIRED
111 forparams CDATA #IMPLIED
114 <!ELEMENT localdecl-code (#PCDATA | context-code)*
>
116 <!ELEMENT setter-code (context-code? , name-code, parameter-code*)
>