libjava/classpath/tools/resource/gnu/classpath/tools/gjdoc/rng/gjdoc-common.rng

   1 <?xml version="1.0"?>\r
   2 \r
   3 <!-- gjdoc-common.rng\r
   4      Copyright (C) 2003 Free Software Foundation, Inc.\r
   5 \r
   6 This file is part of GNU Classpath.\r
   7 \r
   8 GNU Classpath is free software; you can redistribute it and/or modify\r
   9 it under the terms of the GNU General Public License as published by\r
  10 the Free Software Foundation; either version 2, or (at your option)\r
  11 any later version.\r
  12  \r
  13 GNU Classpath is distributed in the hope that it will be useful, but\r
  14 WITHOUT ANY WARRANTY; without even the implied warranty of\r
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\r
  16 General Public License for more details.\r
  17 \r
  18 You should have received a copy of the GNU General Public License\r
  19 along with GNU Classpath; see the file COPYING.  If not, write to the\r
  20 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA\r
  21 02111-1307 USA. -->\r
  22 \r
  23 <grammar \r
  24       xmlns="http://relaxng.org/ns/structure/1.0" \r
  25       xmlns:a="http://relaxng.org/ns/annotation/1.0" \r
  26       xmlns:gjdoc="http://www.gnu.org/software/cp-tools/gjdocxml">\r
  27    \r
  28    <a:documentation>\r
  29       A Relax NG grammar with definitions of elements and attributes\r
  30       used by both the XML index file and the XML class files\r
  31       generated by GNU Gjdoc.\r
  32    </a:documentation>\r
  33 \r
  34    <define name="firstSentenceTags-element">\r
  35       <a:documentation>\r
  36 \r
  37       </a:documentation>\r
  38 \r
  39       <element name="gjdoc:firstSentenceTags">\r
  40          <ref name="tags-contents"/>\r
  41       </element>\r
  42    </define>\r
  43 \r
  44    <define name="inlineTags-element">\r
  45       <a:documentation>\r
  46 \r
  47       </a:documentation>\r
  48 \r
  49       <element name="gjdoc:inlineTags">\r
  50          <ref name="tags-contents"/>\r
  51       </element>\r
  52    </define>\r
  53 \r
  54    <define name="seeTags-element">\r
  55       <a:documentation>\r
  56 \r
  57       </a:documentation>\r
  58 \r
  59       <element name="gjdoc:seeTags">\r
  60          <ref name="tags-contents"/>\r
  61       </element>\r
  62    </define>\r
  63 \r
  64 \r
  65    <define name="tags-element">\r
  66       <a:documentation>\r
  67 \r
  68       </a:documentation>\r
  69 \r
  70       <element name="gjdoc:tags">\r
  71          <ref name="tags-contents"/>\r
  72       </element>\r
  73    </define>\r
  74 \r
  75    <define name="tags-contents">\r
  76       <a:documentation>\r
  77          Specifies mixed content comprised of gjdoc tags,\r
  78          HTML tags, taglet output, and text.\r
  79       </a:documentation>\r
  80 \r
  81       <zeroOrMore>\r
  82          <ref name="TagContent"/>\r
  83       </zeroOrMore>\r
  84    </define>\r
  85 \r
  86    <define name="implements-element">\r
  87       <element name="gjdoc:implements">\r
  88          <a:documentation>\r
  89             Specifies an interface that the class implements.\r
  90          </a:documentation>\r
  91          \r
  92          <ref name="typedef-attributes"/>\r
  93       </element>\r
  94    </define>\r
  95 \r
  96 \r
  97    <define name="superimplements-element">\r
  98       <element name="gjdoc:superimplements">\r
  99          <a:documentation>\r
 100             Specifies an interface implemented by superclasses\r
 101             (ancestors) of the class. Together with the interfaces\r
 102             specified with tag `implements', this lists all interfaces\r
 103             the class can be cast to.\r
 104          </a:documentation>\r
 105          \r
 106          <ref name="typedef-attributes"/>\r
 107       </element>\r
 108    </define>\r
 109 \r
 110    <define name="typedef-attributes">\r
 111       <attribute name="typename">\r
 112          <a:documentation>\r
 113             The name of the class, without package prefix. If the\r
 114             class is an inner class, this includes the name of its\r
 115             outer class.\r
 116          </a:documentation>\r
 117 \r
 118          <text/>\r
 119       </attribute>\r
 120       \r
 121       <ref name="qualifiedtypename-attribute"/>\r
 122 \r
 123       <optional>\r
 124          <attribute name="dimension">\r
 125             <a:documentation>\r
 126                The dimension of this typedef, represented by a zero or\r
 127                more repetitions of the string "[]".\r
 128             </a:documentation>\r
 129 \r
 130             <text/>\r
 131          </attribute>\r
 132       </optional>\r
 133    </define>\r
 134 \r
 135    <define name="name-attribute">\r
 136       <attribute name="name">\r
 137          <a:documentation>\r
 138             The name of some Java Entity (package, class, constructor,\r
 139             method, field.)\r
 140          </a:documentation>\r
 141 \r
 142          <text/>\r
 143       </attribute>\r
 144    </define>\r
 145 \r
 146    <define name="qualifiedtypename-attribute">\r
 147       <attribute name="qualifiedtypename">\r
 148          <a:documentation>\r
 149             The fully qualified name of the class.\r
 150          </a:documentation>\r
 151 \r
 152          <text/>\r
 153       </attribute>\r
 154    </define>\r
 155 \r
 156    <define name="superclass-element">\r
 157       <element name="gjdoc:superclass">\r
 158          <a:documentation>\r
 159             Specifies the superclass of the class.\r
 160          </a:documentation>\r
 161          \r
 162          <ref name="typedef-attributes"/>\r
 163       </element>\r
 164    </define>\r
 165 \r
 166    <define name="tag-element">\r
 167       <element name="gjdoc:tag">\r
 168          <ref name="name-attribute"/>\r
 169          <attribute name="kind">\r
 170             <text/>\r
 171          </attribute>\r
 172          <zeroOrMore>\r
 173             <ref name="TagContent"/>\r
 174          </zeroOrMore>\r
 175       </element>\r
 176    </define>\r
 177 \r
 178    <define name="exception-element">\r
 179       <element name="gjdoc:exception">\r
 180          <ref name="typedef-attributes"/>\r
 181       </element>\r
 182    </define>\r
 183 \r
 184    <define name="TagContent">\r
 185       <choice>\r
 186          <element>\r
 187             <anyName>\r
 188                <except>\r
 189                   <nsName ns="gjdoc"/>\r
 190                   <name>gjdoc:tag</name>\r
 191                </except>\r
 192             </anyName>\r
 193             <zeroOrMore>\r
 194                <attribute>\r
 195                   <anyName/>\r
 196                </attribute>\r
 197             </zeroOrMore>\r
 198             <zeroOrMore>\r
 199                <choice>\r
 200                   <text/>\r
 201                   <ref name="TagContent"/>\r
 202                </choice>\r
 203             </zeroOrMore>\r
 204          </element>\r
 205          <ref name="tag-element"/>\r
 206          <ref name="exception-element"/>\r
 207          <ref name="tagletText-element"/>\r
 208          <text/>\r
 209       </choice>\r
 210    </define>\r
 211 \r
 212    <define name="containingPackage-element">\r
 213       <element name="gjdoc:containingPackage">\r
 214          <a:documentation>\r
 215             The full name of the package containing the class.\r
 216          </a:documentation>\r
 217          <attribute name="name">\r
 218             <text/>\r
 219          </attribute>\r
 220       </element>\r
 221    </define>\r
 222 \r
 223    <define name="tagletText-element">\r
 224       <element name="gjdoc:tagletText">\r
 225          <a:documentation>\r
 226             A string generated by a Taglet.toString() method.\r
 227          </a:documentation>\r
 228          <attribute name="tagName">\r
 229             <a:documentation>\r
 230                The name of the tag this Taglet was assigned to.\r
 231             </a:documentation>\r
 232             <text/>\r
 233          </attribute>\r
 234       </element>\r
 235    </define>\r
 236 \r
 237    <define name="isError-element">\r
 238       <element name="gjdoc:isError">\r
 239          <a:documentation>\r
 240             Exists when the described class is a subclass of\r
 241             java.lang.Error.\r
 242          </a:documentation>\r
 243       </element>\r
 244    </define>\r
 245 \r
 246    <define name="isException-element">\r
 247       <element name="gjdoc:isException">\r
 248          <a:documentation>\r
 249             Exists when the described class is a subclass of\r
 250             java.lang.Exception.\r
 251          </a:documentation>\r
 252       </element>\r
 253    </define>\r
 254 \r
 255    <define name="isInterface-element">\r
 256       <element name="gjdoc:isInterface">\r
 257          <a:documentation>\r
 258             Exists when the described class is an interface.\r
 259          </a:documentation>\r
 260       </element>\r
 261    </define>\r
 262 \r
 263 </grammar>\r
 264 \r