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

   1 <?xml version="1.0"?>
   2
   3 <!-- gjdoc-index.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    <include href="gjdoc-common.rng"/>
  29
  30    <a:documentation>
  31       The Relax NG grammar for the XML index file generated by GNU
  32       Gjdoc.
  33    </a:documentation>
  34
  35    <start>
  36       <a:documentation>
  37          The root element for a Gjdoc index XML document.
  38       </a:documentation>
  39
  40       <element name="gjdoc:rootdoc">
  41          <a:documentation>
  42             Corresponds to the Javadoc API RootDoc object, the root of
  43             the generated documentation.
  44          </a:documentation>
  45
  46          <zeroOrMore>
  47             <ref name="specifiedclass-element"/>
  48          </zeroOrMore>
  49
  50          <zeroOrMore>
  51             <ref name="specifiedpackage-element"/>
  52          </zeroOrMore>
  53
  54          <zeroOrMore>
  55             <ref name="packagedoc-element"/>
  56          </zeroOrMore>
  57
  58          <zeroOrMore>
  59             <ref name="classdoc-element"/>
  60          </zeroOrMore>
  61       </element>
  62    </start>
  63
  64    <define name="containsClass-element">
  65       <element name="gjdoc:containsClass">
  66          <a:documentation>
  67             Corresponds to a class contained in a package or in
  68             another class.
  69          </a:documentation>
  70
  71          <ref name="qualifiedtypename-attribute"/>
  72       </element>
  73    </define>
  74
  75    <define name="specifiedclass-element">
  76       <element name="gjdoc:specifiedclass">
  77          <a:documentation>
  78             Corresponds to a class named on the Gjdoc command
  79             line.  This is a class the user explicitly wants
  80             documentation generated for.
  81          </a:documentation>
  82
  83          <attribute name="name">
  84             <a:documentation>
  85                The name of the class as given by the user on the command
  86                line. (CHECK)
  87             </a:documentation>
  88
  89             <text/>
  90          </attribute>
  91       </element>
  92    </define>
  93
  94    <define name="specifiedpackage-element">
  95       <element name="gjdoc:specifiedpackage">
  96          <a:documentation>
  97             Corresponds to a package named on the Gjdoc command
  98             line.  This is a package the user explicitly wants
  99             documentation generated for.
 100          </a:documentation>
 101
 102          <attribute name="name">
 103             <a:documentation>
 104                The full name of the package.
 105             </a:documentation>
 106
 107             <text/>
 108          </attribute>
 109       </element>
 110    </define>
 111
 112    <define name="packagedoc-element">
 113       <element name="gjdoc:packagedoc">
 114          <a:documentation>
 115             Corresponds to a package for which XML documentation
 116             has been generated.  This is not necessarily a package
 117             the user requested generation for.
 118          </a:documentation>
 119
 120          <ref name="name-attribute"/>
 121          <ref name="firstSentenceTags-element"/>
 122
 123          <zeroOrMore>
 124             <ref name="containsClass-element"/>
 125          </zeroOrMore>
 126       </element>
 127    </define>
 128
 129    <define name="classdoc-element">
 130       <element name="gjdoc:classdoc">
 131          <a:documentation>
 132             Corresponds to a class for which XML documentation has
 133             been generated.
 134          </a:documentation>
 135
 136          <ref name="name-attribute"/>
 137          <ref name="qualifiedtypename-attribute"/>
 138
 139          <optional>
 140             <a:documentation>
 141                The following is optional because the root class
 142                java.lang.Object does not have a superclass. For all
 143                other classes, this element should be specified.
 144             </a:documentation>
 145
 146             <ref name="superclass-element"/>
 147          </optional>
 148
 149          <zeroOrMore>
 150             <ref name="implements-element"/>
 151          </zeroOrMore>
 152
 153          <zeroOrMore>
 154             <ref name="superimplements-element"/>
 155          </zeroOrMore>
 156
 157          <ref name="containingPackage-element"/>
 158
 159          <zeroOrMore>
 160             <ref name="isError-element"/>
 161          </zeroOrMore>
 162
 163          <zeroOrMore>
 164             <ref name="isException-element"/>
 165          </zeroOrMore>
 166
 167          <zeroOrMore>
 168             <ref name="isInterface-element"/>
 169          </zeroOrMore>
 170
 171          <zeroOrMore>
 172             <ref name="containsClass-element"/>
 173          </zeroOrMore>
 174       </element>
 175    </define>
 176 </grammar>