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

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