VES5.0/doxygen-1.8.12/html/perlmod_tree.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.12"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>Doxygen: Perl Module Tree Nodes</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="resize.js"></script>
  14 <script type="text/javascript" src="navtreedata.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18 </script>
  19 <link href="doxygen_manual.css" rel="stylesheet" type="text/css" />
  20 </head>
  21 <body>
  22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23 <div id="titlearea">
  24 <table cellspacing="0" cellpadding="0">
  25  <tbody>
  26  <tr style="height: 56px;">
  27   <td id="projectalign" style="padding-left: 0.5em;">
  28    <div id="projectname">Doxygen
  29    </div>
  30   </td>
  31  </tr>
  32  </tbody>
  33 </table>
  34 </div>
  35 <!-- end header part -->
  36 <!-- Generated by Doxygen 1.8.12 -->
  37 </div><!-- top -->
  38 <div id="side-nav" class="ui-resizable side-nav-resizable">
  39   <div id="nav-tree">
  40     <div id="nav-tree-contents">
  41       <div id="nav-sync" class="sync"></div>
  42     </div>
  43   </div>
  44   <div id="splitbar" style="-moz-user-select:none;"
  45        class="ui-resizable-handle">
  46   </div>
  47 </div>
  48 <script type="text/javascript">
  49 $(document).ready(function(){initNavTree('perlmod_tree.html','');});
  50 </script>
  51 <div id="doc-content">
  52 <div class="header">
  53   <div class="headertitle">
  54 <div class="title">Perl Module Tree Nodes </div>  </div>
  55 </div><!--header-->
  56 <div class="contents">
  57 <div class="textblock"><h2>Nodes in the documentation tree of the Perl Module output format.</h2>
  58 <p>This is a description of the structure of the documentation tree in <b>DoxyDocs.pm</b>. Each item in the list below describes a node in the tree, and the format of the description is as follows:</p>
  59 <ul>
  60 <li>
  61 [ key =&gt; ] <b>Name</b> <em>(type)</em>. Explanation of the content. </li>
  62 </ul>
  63 <p>Where</p>
  64 <ul>
  65 <li>
  66 <p class="startli">The "key =&gt;" part only appears if the parent node is a hash. "key" is the key for this node.</p>
  67 <p class="endli"></p>
  68 </li>
  69 <li>
  70 <p class="startli"><b>"Name"</b> is a unique name for the node, defined in DoxyModel.pm.</p>
  71 <p class="endli"></p>
  72 </li>
  73 <li>
  74 <p class="startli"><em>"(type)"</em> is the type of the node: "string" for string nodes, "hash" for hash nodes, "list" for list nodes, and "doc" for documentation subtrees. The structure of documentation subtrees is not described anywhere yet, but you can look for example at <b>doxylatex.pl</b> to see how to process it.</p>
  75 <p class="endli"></p>
  76 </li>
  77 </ul>
  78 <p>The meaning of each node in the documentation tree is as follows: </p><ul>
  79 <li>
  80 <b>Root</b> <em>(hash)</em>. Root node. <ul>
  81 <li>
  82 classes =&gt; <b>Classes</b> <em>(list)</em>. Documented classes. <ul>
  83 <li>
  84 <b>Class</b> <em>(hash)</em>. A documented class. <ul>
  85 <li>
  86 protected_members =&gt; <b>ClassProtectedMembers</b> <em>(hash)</em>. Information about the protected members in the class. <ul>
  87 <li>
  88 members =&gt; <b>ClassProtectedMemberList</b> <em>(list)</em>. protected member list. <ul>
  89 <li>
  90 <b>ClassProtectedMember</b> <em>(hash)</em>. A protected member. <ul>
  91 <li>
  92 protection =&gt; <b>ClassProtectedMemberProtection</b> <em>(string)</em>. Protection of the protected member. </li>
  93 <li>
  94 detailed =&gt; <b>ClassProtectedMemberDetailed</b> <em>(hash)</em>. Detailed information about the protected member. <ul>
  95 <li>
  96 doc =&gt; <b>ClassProtectedMemberDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the protected member. </li>
  97 <li>
  98 see =&gt; <b>ClassProtectedMemberSee</b> <em>(doc)</em>. "See also" documentation for the protected member. </li>
  99 </ul>
 100 </li>
 101 <li>
 102 kind =&gt; <b>ClassProtectedMemberKind</b> <em>(string)</em>. Kind of protected member (usually "variable"). </li>
 103 <li>
 104 name =&gt; <b>ClassProtectedMemberName</b> <em>(string)</em>. Name of the protected member. </li>
 105 <li>
 106 type =&gt; <b>ClassProtectedMemberType</b> <em>(string)</em>. Data type of the protected member. </li>
 107 </ul>
 108 </li>
 109 </ul>
 110 </li>
 111 </ul>
 112 </li>
 113 <li>
 114 detailed =&gt; <b>ClassDetailed</b> <em>(hash)</em>. Detailed information about the class. <ul>
 115 <li>
 116 doc =&gt; <b>ClassDetailedDoc</b> <em>(doc)</em>. Detailed documentation block for the class. </li>
 117 </ul>
 118 </li>
 119 <li>
 120 protected_typedefs =&gt; <b>ClassProtectedTypedefs</b> <em>(hash)</em>. Information about the protected typedefs in the class. <ul>
 121 <li>
 122 members =&gt; <b>ClassProtectedTypedefList</b> <em>(list)</em>. protected typedef list. <ul>
 123 <li>
 124 <b>ClassProtectedTypedef</b> <em>(hash)</em>. A protected typedef. <ul>
 125 <li>
 126 protection =&gt; <b>ClassProtectedTypedefProtection</b> <em>(string)</em>. Protection of the protected typedef. </li>
 127 <li>
 128 detailed =&gt; <b>ClassProtectedTypedefDetailed</b> <em>(hash)</em>. Detailed information about the protected typedef. <ul>
 129 <li>
 130 doc =&gt; <b>ClassProtectedTypedefDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the protected typedef. </li>
 131 <li>
 132 see =&gt; <b>ClassProtectedTypedefSee</b> <em>(doc)</em>. "See also" documentation for the protected typedef. </li>
 133 </ul>
 134 </li>
 135 <li>
 136 kind =&gt; <b>ClassProtectedTypedefKind</b> <em>(string)</em>. Kind of protected typedef (usually "typedef"). </li>
 137 <li>
 138 name =&gt; <b>ClassProtectedTypedefName</b> <em>(string)</em>. Name of the protected typedef. </li>
 139 <li>
 140 type =&gt; <b>ClassProtectedTypedefType</b> <em>(string)</em>. Data type of the protected typedef. </li>
 141 </ul>
 142 </li>
 143 </ul>
 144 </li>
 145 </ul>
 146 </li>
 147 <li>
 148 name =&gt; <b>ClassName</b> <em>(string)</em>. Name of the class. </li>
 149 <li>
 150 private_members =&gt; <b>ClassPrivateMembers</b> <em>(hash)</em>. Information about the private members in the class. <ul>
 151 <li>
 152 members =&gt; <b>ClassPrivateMemberList</b> <em>(list)</em>. private member list. <ul>
 153 <li>
 154 <b>ClassPrivateMember</b> <em>(hash)</em>. A private member. <ul>
 155 <li>
 156 protection =&gt; <b>ClassPrivateMemberProtection</b> <em>(string)</em>. Protection of the private member. </li>
 157 <li>
 158 detailed =&gt; <b>ClassPrivateMemberDetailed</b> <em>(hash)</em>. Detailed information about the private member. <ul>
 159 <li>
 160 doc =&gt; <b>ClassPrivateMemberDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the private member. </li>
 161 <li>
 162 see =&gt; <b>ClassPrivateMemberSee</b> <em>(doc)</em>. "See also" documentation for the private member. </li>
 163 </ul>
 164 </li>
 165 <li>
 166 kind =&gt; <b>ClassPrivateMemberKind</b> <em>(string)</em>. Kind of private member (usually "variable"). </li>
 167 <li>
 168 name =&gt; <b>ClassPrivateMemberName</b> <em>(string)</em>. Name of the private member. </li>
 169 <li>
 170 type =&gt; <b>ClassPrivateMemberType</b> <em>(string)</em>. Data type of the private member. </li>
 171 </ul>
 172 </li>
 173 </ul>
 174 </li>
 175 </ul>
 176 </li>
 177 <li>
 178 private_typedefs =&gt; <b>ClassPrivateTypedefs</b> <em>(hash)</em>. Information about the private typedefs in the class. <ul>
 179 <li>
 180 members =&gt; <b>ClassPrivateTypedefList</b> <em>(list)</em>. private typedef list. <ul>
 181 <li>
 182 <b>ClassPrivateTypedef</b> <em>(hash)</em>. A private typedef. <ul>
 183 <li>
 184 protection =&gt; <b>ClassPrivateTypedefProtection</b> <em>(string)</em>. Protection of the private typedef. </li>
 185 <li>
 186 detailed =&gt; <b>ClassPrivateTypedefDetailed</b> <em>(hash)</em>. Detailed information about the private typedef. <ul>
 187 <li>
 188 doc =&gt; <b>ClassPrivateTypedefDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the private typedef. </li>
 189 <li>
 190 see =&gt; <b>ClassPrivateTypedefSee</b> <em>(doc)</em>. "See also" documentation for the private typedef. </li>
 191 </ul>
 192 </li>
 193 <li>
 194 kind =&gt; <b>ClassPrivateTypedefKind</b> <em>(string)</em>. Kind of private typedef (usually "typedef"). </li>
 195 <li>
 196 name =&gt; <b>ClassPrivateTypedefName</b> <em>(string)</em>. Name of the private typedef. </li>
 197 <li>
 198 type =&gt; <b>ClassPrivateTypedefType</b> <em>(string)</em>. Data type of the private typedef. </li>
 199 </ul>
 200 </li>
 201 </ul>
 202 </li>
 203 </ul>
 204 </li>
 205 <li>
 206 protected_methods =&gt; <b>ClassProtectedMethods</b> <em>(hash)</em>. Information about the protected methods in the class. <ul>
 207 <li>
 208 members =&gt; <b>ClassProtectedMethodList</b> <em>(list)</em>. protected method list. <ul>
 209 <li>
 210 <b>ClassProtectedMethod</b> <em>(hash)</em>. A protected method. <ul>
 211 <li>
 212 parameters =&gt; <b>ClassProtectedMethodParams</b> <em>(list)</em>. List of the parameters of the protected method. <ul>
 213 <li>
 214 <b>ClassProtectedMethodParam</b> <em>(hash)</em>. A parameter of the protected method. <ul>
 215 <li>
 216 declaration_name =&gt; <b>ClassProtectedMethodParamName</b> <em>(string)</em>. The name of the parameter. </li>
 217 <li>
 218 type =&gt; <b>ClassProtectedMethodParamType</b> <em>(string)</em>. The data type of the parameter. </li>
 219 </ul>
 220 </li>
 221 </ul>
 222 </li>
 223 <li>
 224 protection =&gt; <b>ClassProtectedMethodProtection</b> <em>(string)</em>. Protection of the protected method. </li>
 225 <li>
 226 virtualness =&gt; <b>ClassProtectedMethodVirtualness</b> <em>(string)</em>. Virtualness of the protected method. </li>
 227 <li>
 228 detailed =&gt; <b>ClassProtectedMethodDetailed</b> <em>(hash)</em>. Detailed information about the protected method. <ul>
 229 <li>
 230 params =&gt; <b>ClassProtectedMethodPDBlocks</b> <em>(list)</em>. List of parameter documentation blocks for the protected method. <ul>
 231 <li>
 232 <b>ClassProtectedMethodPDBlock</b> <em>(hash)</em>. A parameter documentation block for the protected method. <ul>
 233 <li>
 234 parameters =&gt; <b>ClassProtectedMethodPDParams</b> <em>(list)</em>. Parameter list for this parameter documentation block. <ul>
 235 <li>
 236 <b>ClassProtectedMethodPDParam</b> <em>(hash)</em>. A parameter documented by this documentation block. <ul>
 237 <li>
 238 name =&gt; <b>ClassProtectedMethodPDParamName</b> <em>(string)</em>. Name of the parameter. </li>
 239 </ul>
 240 </li>
 241 </ul>
 242 </li>
 243 <li>
 244 doc =&gt; <b>ClassProtectedMethodPDDoc</b> <em>(doc)</em>. Documentation for this parameter documentation block. </li>
 245 </ul>
 246 </li>
 247 </ul>
 248 </li>
 249 <li>
 250 doc =&gt; <b>ClassProtectedMethodDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the protected method. </li>
 251 <li>
 252 see =&gt; <b>ClassProtectedMethodSee</b> <em>(doc)</em>. "See also" documentation for the protected method. </li>
 253 <li>
 254 return =&gt; <b>ClassProtectedMethodReturn</b> <em>(doc)</em>. Documentation about the return value of the protected method. </li>
 255 </ul>
 256 </li>
 257 <li>
 258 kind =&gt; <b>ClassProtectedMethodKind</b> <em>(string)</em>. Kind of protected method (usually "function"). </li>
 259 <li>
 260 name =&gt; <b>ClassProtectedMethodName</b> <em>(string)</em>. Name of the protected method. </li>
 261 <li>
 262 type =&gt; <b>ClassProtectedMethodType</b> <em>(string)</em>. Data type returned by the protected method. </li>
 263 <li>
 264 static =&gt; <b>ClassProtectedMethodStatic</b> <em>(string)</em>. Whether the protected method is static. </li>
 265 </ul>
 266 </li>
 267 </ul>
 268 </li>
 269 </ul>
 270 </li>
 271 <li>
 272 public_typedefs =&gt; <b>ClassPublicTypedefs</b> <em>(hash)</em>. Information about the public typedefs in the class. <ul>
 273 <li>
 274 members =&gt; <b>ClassPublicTypedefList</b> <em>(list)</em>. public typedef list. <ul>
 275 <li>
 276 <b>ClassPublicTypedef</b> <em>(hash)</em>. A public typedef. <ul>
 277 <li>
 278 protection =&gt; <b>ClassPublicTypedefProtection</b> <em>(string)</em>. Protection of the public typedef. </li>
 279 <li>
 280 detailed =&gt; <b>ClassPublicTypedefDetailed</b> <em>(hash)</em>. Detailed information about the public typedef. <ul>
 281 <li>
 282 doc =&gt; <b>ClassPublicTypedefDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the public typedef. </li>
 283 <li>
 284 see =&gt; <b>ClassPublicTypedefSee</b> <em>(doc)</em>. "See also" documentation for the public typedef. </li>
 285 </ul>
 286 </li>
 287 <li>
 288 kind =&gt; <b>ClassPublicTypedefKind</b> <em>(string)</em>. Kind of public typedef (usually "typedef"). </li>
 289 <li>
 290 name =&gt; <b>ClassPublicTypedefName</b> <em>(string)</em>. Name of the public typedef. </li>
 291 <li>
 292 type =&gt; <b>ClassPublicTypedefType</b> <em>(string)</em>. Data type of the public typedef. </li>
 293 </ul>
 294 </li>
 295 </ul>
 296 </li>
 297 </ul>
 298 </li>
 299 <li>
 300 public_members =&gt; <b>ClassPublicMembers</b> <em>(hash)</em>. Information about the public members in the class. <ul>
 301 <li>
 302 members =&gt; <b>ClassPublicMemberList</b> <em>(list)</em>. public member list. <ul>
 303 <li>
 304 <b>ClassPublicMember</b> <em>(hash)</em>. A public member. <ul>
 305 <li>
 306 protection =&gt; <b>ClassPublicMemberProtection</b> <em>(string)</em>. Protection of the public member. </li>
 307 <li>
 308 detailed =&gt; <b>ClassPublicMemberDetailed</b> <em>(hash)</em>. Detailed information about the public member. <ul>
 309 <li>
 310 doc =&gt; <b>ClassPublicMemberDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the public member. </li>
 311 <li>
 312 see =&gt; <b>ClassPublicMemberSee</b> <em>(doc)</em>. "See also" documentation for the public member. </li>
 313 </ul>
 314 </li>
 315 <li>
 316 kind =&gt; <b>ClassPublicMemberKind</b> <em>(string)</em>. Kind of public member (usually "variable"). </li>
 317 <li>
 318 name =&gt; <b>ClassPublicMemberName</b> <em>(string)</em>. Name of the public member. </li>
 319 <li>
 320 type =&gt; <b>ClassPublicMemberType</b> <em>(string)</em>. Data type of the public member. </li>
 321 </ul>
 322 </li>
 323 </ul>
 324 </li>
 325 </ul>
 326 </li>
 327 <li>
 328 private_methods =&gt; <b>ClassPrivateMethods</b> <em>(hash)</em>. Information about the private methods in the class. <ul>
 329 <li>
 330 members =&gt; <b>ClassPrivateMethodList</b> <em>(list)</em>. private method list. <ul>
 331 <li>
 332 <b>ClassPrivateMethod</b> <em>(hash)</em>. A private method. <ul>
 333 <li>
 334 parameters =&gt; <b>ClassPrivateMethodParams</b> <em>(list)</em>. List of the parameters of the private method. <ul>
 335 <li>
 336 <b>ClassPrivateMethodParam</b> <em>(hash)</em>. A parameter of the private method. <ul>
 337 <li>
 338 declaration_name =&gt; <b>ClassPrivateMethodParamName</b> <em>(string)</em>. The name of the parameter. </li>
 339 <li>
 340 type =&gt; <b>ClassPrivateMethodParamType</b> <em>(string)</em>. The data type of the parameter. </li>
 341 </ul>
 342 </li>
 343 </ul>
 344 </li>
 345 <li>
 346 protection =&gt; <b>ClassPrivateMethodProtection</b> <em>(string)</em>. Protection of the private method. </li>
 347 <li>
 348 virtualness =&gt; <b>ClassPrivateMethodVirtualness</b> <em>(string)</em>. Virtualness of the private method. </li>
 349 <li>
 350 detailed =&gt; <b>ClassPrivateMethodDetailed</b> <em>(hash)</em>. Detailed information about the private method. <ul>
 351 <li>
 352 params =&gt; <b>ClassPrivateMethodPDBlocks</b> <em>(list)</em>. List of parameter documentation blocks for the private method. <ul>
 353 <li>
 354 <b>ClassPrivateMethodPDBlock</b> <em>(hash)</em>. A parameter documentation block for the private method. <ul>
 355 <li>
 356 parameters =&gt; <b>ClassPrivateMethodPDParams</b> <em>(list)</em>. Parameter list for this parameter documentation block. <ul>
 357 <li>
 358 <b>ClassPrivateMethodPDParam</b> <em>(hash)</em>. A parameter documented by this documentation block. <ul>
 359 <li>
 360 name =&gt; <b>ClassPrivateMethodPDParamName</b> <em>(string)</em>. Name of the parameter. </li>
 361 </ul>
 362 </li>
 363 </ul>
 364 </li>
 365 <li>
 366 doc =&gt; <b>ClassPrivateMethodPDDoc</b> <em>(doc)</em>. Documentation for this parameter documentation block. </li>
 367 </ul>
 368 </li>
 369 </ul>
 370 </li>
 371 <li>
 372 doc =&gt; <b>ClassPrivateMethodDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the private method. </li>
 373 <li>
 374 see =&gt; <b>ClassPrivateMethodSee</b> <em>(doc)</em>. "See also" documentation for the private method. </li>
 375 <li>
 376 return =&gt; <b>ClassPrivateMethodReturn</b> <em>(doc)</em>. Documentation about the return value of the private method. </li>
 377 </ul>
 378 </li>
 379 <li>
 380 kind =&gt; <b>ClassPrivateMethodKind</b> <em>(string)</em>. Kind of private method (usually "function"). </li>
 381 <li>
 382 name =&gt; <b>ClassPrivateMethodName</b> <em>(string)</em>. Name of the private method. </li>
 383 <li>
 384 type =&gt; <b>ClassPrivateMethodType</b> <em>(string)</em>. Data type returned by the private method. </li>
 385 <li>
 386 static =&gt; <b>ClassPrivateMethodStatic</b> <em>(string)</em>. Whether the private method is static. </li>
 387 </ul>
 388 </li>
 389 </ul>
 390 </li>
 391 </ul>
 392 </li>
 393 <li>
 394 public_methods =&gt; <b>ClassPublicMethods</b> <em>(hash)</em>. Information about the public methods in the class. <ul>
 395 <li>
 396 members =&gt; <b>ClassPublicMethodList</b> <em>(list)</em>. public method list. <ul>
 397 <li>
 398 <b>ClassPublicMethod</b> <em>(hash)</em>. A public method. <ul>
 399 <li>
 400 parameters =&gt; <b>ClassPublicMethodParams</b> <em>(list)</em>. List of the parameters of the public method. <ul>
 401 <li>
 402 <b>ClassPublicMethodParam</b> <em>(hash)</em>. A parameter of the public method. <ul>
 403 <li>
 404 declaration_name =&gt; <b>ClassPublicMethodParamName</b> <em>(string)</em>. The name of the parameter. </li>
 405 <li>
 406 type =&gt; <b>ClassPublicMethodParamType</b> <em>(string)</em>. The data type of the parameter. </li>
 407 </ul>
 408 </li>
 409 </ul>
 410 </li>
 411 <li>
 412 protection =&gt; <b>ClassPublicMethodProtection</b> <em>(string)</em>. Protection of the public method. </li>
 413 <li>
 414 virtualness =&gt; <b>ClassPublicMethodVirtualness</b> <em>(string)</em>. Virtualness of the public method. </li>
 415 <li>
 416 detailed =&gt; <b>ClassPublicMethodDetailed</b> <em>(hash)</em>. Detailed information about the public method. <ul>
 417 <li>
 418 params =&gt; <b>ClassPublicMethodPDBlocks</b> <em>(list)</em>. List of parameter documentation blocks for the public method. <ul>
 419 <li>
 420 <b>ClassPublicMethodPDBlock</b> <em>(hash)</em>. A parameter documentation block for the public method. <ul>
 421 <li>
 422 parameters =&gt; <b>ClassPublicMethodPDParams</b> <em>(list)</em>. Parameter list for this parameter documentation block. <ul>
 423 <li>
 424 <b>ClassPublicMethodPDParam</b> <em>(hash)</em>. A parameter documented by this documentation block. <ul>
 425 <li>
 426 name =&gt; <b>ClassPublicMethodPDParamName</b> <em>(string)</em>. Name of the parameter. </li>
 427 </ul>
 428 </li>
 429 </ul>
 430 </li>
 431 <li>
 432 doc =&gt; <b>ClassPublicMethodPDDoc</b> <em>(doc)</em>. Documentation for this parameter documentation block. </li>
 433 </ul>
 434 </li>
 435 </ul>
 436 </li>
 437 <li>
 438 doc =&gt; <b>ClassPublicMethodDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the public method. </li>
 439 <li>
 440 see =&gt; <b>ClassPublicMethodSee</b> <em>(doc)</em>. "See also" documentation for the public method. </li>
 441 <li>
 442 return =&gt; <b>ClassPublicMethodReturn</b> <em>(doc)</em>. Documentation about the return value of the public method. </li>
 443 </ul>
 444 </li>
 445 <li>
 446 kind =&gt; <b>ClassPublicMethodKind</b> <em>(string)</em>. Kind of public method (usually "function"). </li>
 447 <li>
 448 name =&gt; <b>ClassPublicMethodName</b> <em>(string)</em>. Name of the public method. </li>
 449 <li>
 450 type =&gt; <b>ClassPublicMethodType</b> <em>(string)</em>. Data type returned by the public method. </li>
 451 <li>
 452 static =&gt; <b>ClassPublicMethodStatic</b> <em>(string)</em>. Whether the public method is static. </li>
 453 </ul>
 454 </li>
 455 </ul>
 456 </li>
 457 </ul>
 458 </li>
 459 </ul>
 460 </li>
 461 </ul>
 462 </li>
 463 <li>
 464 files =&gt; <b>Files</b> <em>(list)</em>. Documented files. <ul>
 465 <li>
 466 <b>File</b> <em>(hash)</em>. A documented file. <ul>
 467 <li>
 468 detailed =&gt; <b>FileDetailed</b> <em>(hash)</em>. Detailed information about the file. <ul>
 469 <li>
 470 doc =&gt; <b>FileDetailedDoc</b> <em>(doc)</em>. Detailed documentation block for the file. </li>
 471 </ul>
 472 </li>
 473 <li>
 474 functions =&gt; <b>FileFunctions</b> <em>(hash)</em>. Information about the functions in the file. <ul>
 475 <li>
 476 members =&gt; <b>FileFunctionList</b> <em>(list)</em>. function list. <ul>
 477 <li>
 478 <b>FileFunction</b> <em>(hash)</em>. A function. <ul>
 479 <li>
 480 parameters =&gt; <b>FileFunctionParams</b> <em>(list)</em>. List of the parameters of the function. <ul>
 481 <li>
 482 <b>FileFunctionParam</b> <em>(hash)</em>. A parameter of the function. <ul>
 483 <li>
 484 declaration_name =&gt; <b>FileFunctionParamName</b> <em>(string)</em>. The name of the parameter. </li>
 485 <li>
 486 type =&gt; <b>FileFunctionParamType</b> <em>(string)</em>. The data type of the parameter. </li>
 487 </ul>
 488 </li>
 489 </ul>
 490 </li>
 491 <li>
 492 protection =&gt; <b>FileFunctionProtection</b> <em>(string)</em>. Protection of the function. </li>
 493 <li>
 494 virtualness =&gt; <b>FileFunctionVirtualness</b> <em>(string)</em>. Virtualness of the function. </li>
 495 <li>
 496 detailed =&gt; <b>FileFunctionDetailed</b> <em>(hash)</em>. Detailed information about the function. <ul>
 497 <li>
 498 params =&gt; <b>FileFunctionPDBlocks</b> <em>(list)</em>. List of parameter documentation blocks for the function. <ul>
 499 <li>
 500 <b>FileFunctionPDBlock</b> <em>(hash)</em>. A parameter documentation block for the function. <ul>
 501 <li>
 502 parameters =&gt; <b>FileFunctionPDParams</b> <em>(list)</em>. Parameter list for this parameter documentation block. <ul>
 503 <li>
 504 <b>FileFunctionPDParam</b> <em>(hash)</em>. A parameter documented by this documentation block. <ul>
 505 <li>
 506 name =&gt; <b>FileFunctionPDParamName</b> <em>(string)</em>. Name of the parameter. </li>
 507 </ul>
 508 </li>
 509 </ul>
 510 </li>
 511 <li>
 512 doc =&gt; <b>FileFunctionPDDoc</b> <em>(doc)</em>. Documentation for this parameter documentation block. </li>
 513 </ul>
 514 </li>
 515 </ul>
 516 </li>
 517 <li>
 518 doc =&gt; <b>FileFunctionDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the function. </li>
 519 <li>
 520 see =&gt; <b>FileFunctionSee</b> <em>(doc)</em>. "See also" documentation for the function. </li>
 521 <li>
 522 return =&gt; <b>FileFunctionReturn</b> <em>(doc)</em>. Documentation about the return value of the function. </li>
 523 </ul>
 524 </li>
 525 <li>
 526 kind =&gt; <b>FileFunctionKind</b> <em>(string)</em>. Kind of function (usually "function"). </li>
 527 <li>
 528 name =&gt; <b>FileFunctionName</b> <em>(string)</em>. Name of the function. </li>
 529 <li>
 530 type =&gt; <b>FileFunctionType</b> <em>(string)</em>. Data type returned by the function. </li>
 531 <li>
 532 static =&gt; <b>FileFunctionStatic</b> <em>(string)</em>. Whether the function is static. </li>
 533 </ul>
 534 </li>
 535 </ul>
 536 </li>
 537 </ul>
 538 </li>
 539 <li>
 540 name =&gt; <b>FileName</b> <em>(string)</em>. Name of the file. </li>
 541 <li>
 542 variables =&gt; <b>FileVariables</b> <em>(hash)</em>. Information about the variables in the file. <ul>
 543 <li>
 544 members =&gt; <b>FileVariableList</b> <em>(list)</em>. variable list. <ul>
 545 <li>
 546 <b>FileVariable</b> <em>(hash)</em>. A variable. <ul>
 547 <li>
 548 protection =&gt; <b>FileVariableProtection</b> <em>(string)</em>. Protection of the variable. </li>
 549 <li>
 550 detailed =&gt; <b>FileVariableDetailed</b> <em>(hash)</em>. Detailed information about the variable. <ul>
 551 <li>
 552 doc =&gt; <b>FileVariableDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the variable. </li>
 553 <li>
 554 see =&gt; <b>FileVariableSee</b> <em>(doc)</em>. "See also" documentation for the variable. </li>
 555 </ul>
 556 </li>
 557 <li>
 558 kind =&gt; <b>FileVariableKind</b> <em>(string)</em>. Kind of variable (usually "variable"). </li>
 559 <li>
 560 name =&gt; <b>FileVariableName</b> <em>(string)</em>. Name of the variable. </li>
 561 <li>
 562 type =&gt; <b>FileVariableType</b> <em>(string)</em>. Data type of the variable. </li>
 563 </ul>
 564 </li>
 565 </ul>
 566 </li>
 567 </ul>
 568 </li>
 569 <li>
 570 typedefs =&gt; <b>FileTypedefs</b> <em>(hash)</em>. Information about the typedefs in the file. <ul>
 571 <li>
 572 members =&gt; <b>FileTypedefList</b> <em>(list)</em>. typedef list. <ul>
 573 <li>
 574 <b>FileTypedef</b> <em>(hash)</em>. A typedef. <ul>
 575 <li>
 576 protection =&gt; <b>FileTypedefProtection</b> <em>(string)</em>. Protection of the typedef. </li>
 577 <li>
 578 detailed =&gt; <b>FileTypedefDetailed</b> <em>(hash)</em>. Detailed information about the typedef. <ul>
 579 <li>
 580 doc =&gt; <b>FileTypedefDetailedDoc</b> <em>(doc)</em>. Detailed documentation for the typedef. </li>
 581 <li>
 582 see =&gt; <b>FileTypedefSee</b> <em>(doc)</em>. "See also" documentation for the typedef. </li>
 583 </ul>
 584 </li>
 585 <li>
 586 kind =&gt; <b>FileTypedefKind</b> <em>(string)</em>. Kind of typedef (usually "typedef"). </li>
 587 <li>
 588 name =&gt; <b>FileTypedefName</b> <em>(string)</em>. Name of the typedef. </li>
 589 <li>
 590 type =&gt; <b>FileTypedefType</b> <em>(string)</em>. Data type of the typedef. </li>
 591 </ul>
 592 </li>
 593 </ul>
 594 </li>
 595 </ul>
 596 </li>
 597 </ul>
 598 </li>
 599 </ul>
 600 </li>
 601 </ul>
 602 </li>
 603 </ul>
 604 <p>
 605 Go to the <a href="arch.html">next</a> section or return to the
 606  <a href="index.html">index</a>.
 607  </p>
 608 </div></div><!-- contents -->
 609 </div><!-- doc-content -->
 610 <!-- start footer part -->
 611 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 612   <ul>
 613     <li class="footer">Generated by
 614     <a href="http://www.doxygen.org/index.html">
 615     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
 616   </ul>
 617 </div>
 618 </body>
 619 </html>