mods/phpdoc/PHPDoc/apidoc/phpdoc.dtd

   1 <!ENTITY % name 'name CDATA #REQUIRED'>\r
   2 <!ENTITY % undoc 'undoc (true | false) "false"'>\r
   3 <!ENTITY % access 'access (public | private) "private"'>\r
   4 <!ENTITY % abstract 'abstract (true | false) "false"'>\r
   5 <!ENTITY % static 'static (true | false) "false"'>\r
   6 <!ENTITY % final 'final (true | false) "false"'>\r
   7 <!ENTITY % type 'type CDATA'>\r
   8 <!ENTITY % file 'file CDATA'>\r
   9 <!ENTITY % package 'package CDATA'>\r
  10 <!ENTITY % group 'group CDATA'>\r
  11 \r
  12 <!ELEMENT phpdoc (class|module)*>\r
  13 <!ELEMENT class (file, doc?, function*, variable*, uses*, constant*, inherited*, overriden*, path*, baseclass*, subclasses*)>\r
  14 <!ATTLIST class\r
  15                                                 %name;\r
  16                                                 extends CDATA\r
  17                                                 %undoc;\r
  18                                                 %access;\r
  19                                                 %abstract;\r
  20                                                 %static;\r
  21                                                 %final;\r
  22                                                 %package;>\r
  23 \r
  24 <!ELEMENT module (file, doc?, function*, uses*, constant*)>\r
  25 <!ATTLIST module\r
  26                                                 %name;\r
  27                                                 %group;\r
  28                                                 %undoc;\r
  29                                                 %access;\r
  30                                                 %package;>\r
  31 \r
  32 <!ELEMENT variable (#PCDATA, doc?)>\r
  33 <!ATTLIST variable \r
  34                                                 %name;\r
  35                                                 %access;\r
  36                                                 %type;\r
  37                                                 %static;\r
  38                                                 %final;>\r
  39 \r
  40 <!ELEMENT path (parent?)>\r
  41 <!ELEMENT parent (#PCDATA)>\r
  42 \r
  43 <!ELEMENT subclasses (subclass?)>\r
  44 <!ELEMENT subclass (#PCDATA)>\r
  45 \r
  46 <!ELEMENT doc ( link | \r
  47                                                                 author |\r
  48                                                                 see |\r
  49                                                                 parameter |\r
  50                                                                 return |\r
  51                                                                 throws |\r
  52                                                                 global |\r
  53                                                                 inherited |\r
  54                                                                 overriden |\r
  55                                                                 description |\r
  56                                                                 shortdescription |\r
  57                                                                 version |\r
  58                                                                 since |\r
  59                                                                 deprecated |\r
  60                                                                 copyright |\r
  61                                                                 exclude |\r
  62                                                                 brother |\r
  63                                                                 magic \r
  64                                                         )*>\r
  65 \r
  66 \r
  67 <!ELEMENT function (#PCDATA)>\r
  68 <!ATTLIST function \r
  69                                                 %name;\r
  70                                                 %undoc;\r
  71                                                 %access;\r
  72                                                 %abstract;\r
  73                                                 %static;>\r
  74 \r
  75 <!ELEMENT constant (#PCDATA)>\r
  76 <!ATTLIST constant \r
  77                                                 %name;\r
  78                                                 %undoc;\r
  79                                                 %access;\r
  80                                                 case CDATA>\r
  81                                                 \r
  82 <!ELEMENT uses (#PCDATA)>       \r
  83 <!ATTLIST uses\r
  84                                                 %type;\r
  85                                                 %file;\r
  86                                                 %undoc;>\r
  87 \r
  88 \r
  89 <!ELEMENT baseclass (#PCDATA)>\r
  90                                                         \r
  91 <!ELEMENT link (#PCDATA)>\r
  92 <!ATTLIST link\r
  93                                                 url CDATA>\r
  94                                                 \r
  95 <!ELEMENT author (PANIK)>\r
  96 <!ATTLIST author\r
  97                                                 email CDATA> \r
  98                                                         \r
  99 <!ELEMENT see (#PCDATA)>\r
 100 <!ATTLIST see\r
 101                                                 type CDATA #REQUIRED\r
 102                                                 group CDATA>\r
 103                                                 \r
 104 <!ELEMENT parameter (#PCDATA?)>\r
 105 <!ATTLIST parameter\r
 106                                                 %name;\r
 107                                                 %type;\r
 108                                                 value CDATA\r
 109                                                 %undoc;>\r
 110                                                 \r
 111 <!ELEMENT return (#PCDATA)>\r
 112 <!ATTLIST return \r
 113                                                 name CDATA \r
 114                                                 %type; #REQUIRED>\r
 115                                         \r
 116 <!ELEMENT throws (#PCDATA)>\r
 117 \r
 118 <!ELEMENT global (#PCDATA)>\r
 119 <!ATTLIST global\r
 120                                                 name CDATA\r
 121                                                 %type; #REQUIRED>\r
 122                                         \r
 123 <!ELEMENT inherited (element)*>\r
 124 <!ATTLIST inherited \r
 125                                                 type CDATA\r
 126                                                 src CDATA>\r
 127 <!ELEMENT element (#PCDATA)>\r
 128                                                 \r
 129 <!ELEMENT overriden (element)*>\r
 130 <!ATTLIST overriden\r
 131                                                 type CDATA\r
 132                                                 src CDATA>\r
 133 \r
 134                                                 \r
 135 <!ELEMENT description (#PCDATA)>\r
 136 <!ELEMENT shortdescription (#PCDATA)>\r
 137 <!ELEMENT version (#PCDATA)>\r
 138 <!ELEMENT since (#PCDATA)>\r
 139 <!ELEMENT deprecated (#PCDATA)>\r
 140 <!ELEMENT copyright (#PCDATA)>\r
 141 <!ELEMENT exclude (#PCDATA)>\r
 142 <!ELEMENT brother (#PCDATA)>\r
 143 <!ELEMENT magic (#PCDATA)>\r
 144 \r
 145 \r
 146 <!ELEMENT file (#PCDATA)>