diff options
Diffstat (limited to 'doc/perlmod.doc')
| -rw-r--r-- | doc/perlmod.doc | 381 |
1 files changed, 374 insertions, 7 deletions
diff --git a/doc/perlmod.doc b/doc/perlmod.doc index ffee54e..a7dc63d 100644 --- a/doc/perlmod.doc +++ b/doc/perlmod.doc @@ -172,12 +172,6 @@ tree. <p>As you can see, the documentation contained in `$doxydocs` does not present any special impediment to be processed by a simple Perl script. -<!-- -To be able to generate meaningful output using the -documentation contained in `$doxydocs` you'll probably need to -know the semantics of the nodes of the documentation tree, which we -present in \ref perlmod_tree "this page". ---> \section doxymodel_format Data structure @@ -194,7 +188,380 @@ you can look at the Perl scripts generated by doxygen (such as how to use `DoxyModel.pm`. \section perlmod_tree Perl Module Tree Nodes -\includedoc perlmod_tree.doc + +<h3>Nodes in the documentation tree of the Perl Module output +format.</h3> + +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: + +<ul> +<li>[ key => ] <b>Name</b> <i>(type)</i>. Explanation of the content. +</ul> + +Where + +<ul> + +<li>The "key =>" part only appears if the parent node is a hash. +"key" is the key for this node. + +<li><b>"Name"</b> is a unique name for the node, defined in +DoxyModel.pm. + +<li><i>"(type)"</i> 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. + +</ul> + +The meaning of each node in the documentation tree is as follows: +<ul> +<li> <b>Root</b> <i>(hash)</i>. Root node. +<ul> +<li>classes => <b>Classes</b> <i>(list)</i>. Documented classes. +<ul> +<li> <b>Class</b> <i>(hash)</i>. A documented class. +<ul> +<li>protected_members => <b>ClassProtectedMembers</b> <i>(hash)</i>. Information about the protected members in the class. +<ul> +<li>members => <b>ClassProtectedMemberList</b> <i>(list)</i>. protected member list. +<ul> +<li> <b>ClassProtectedMember</b> <i>(hash)</i>. A protected member. +<ul> +<li>protection => <b>ClassProtectedMemberProtection</b> <i>(string)</i>. Protection of the protected member. +<li>detailed => <b>ClassProtectedMemberDetailed</b> <i>(hash)</i>. Detailed information about the protected member. +<ul> +<li>doc => <b>ClassProtectedMemberDetailedDoc</b> <i>(doc)</i>. Detailed documentation for the protected member. +<li>see => <b>ClassProtectedMemberSee</b> <i>(doc)</i>. "See also" documentation for the protected member. +</ul> +<li>kind => <b>ClassProtectedMemberKind</b> <i>(string)</i>. Kind of protected member (usually "variable"). +<li>name => <b>ClassProtectedMemberName</b> <i>(string)</i>. Name of the protected member. +<li>type => <b>ClassProtectedMemberType</b> <i>(string)</i>. Data type of the protected member. +</ul> +</ul> +</ul> +<li>detailed => <b>ClassDetailed</b> <i>(hash)</i>. Detailed information about the class. +<ul> +<li>doc => <b>ClassDetailedDoc</b> <i>(doc)</i>. Detailed documentation block for the class. +</ul> +<li>protected_typedefs => <b>ClassProtectedTypedefs</b> <i>(hash)</i>. Information about the protected typedefs in the class. +<ul> +<li>members => <b>ClassProtectedTypedefList</b> <i>(list)</i>. protected typedef list. +<ul> +<li> <b>ClassProtectedTypedef</b> <i>(hash)</i>. A protected typedef. +<ul> +<li>protection => <b>ClassProtectedTypedefProtection</b> <i>(string)</i>. Protection of the protected typedef. +<li>detailed => <b>ClassProtectedTypedefDetailed</b> <i>(hash)</i>. Detailed information about the protected typedef. +<ul> +<li>doc => <b>ClassProtectedTypedefDetailedDoc</b> <i>(doc)</i>. Detailed documentation for the protected typedef. +<li>see => <b>ClassProtectedTypedefSee</b> <i>(doc)</i>. "See also" documentation for the protected typedef. +</ul> +<li>kind => <b>ClassProtectedTypedefKind</b> <i>(string)</i>. Kind of protected typedef (usually "typedef"). +<li>name => <b>ClassProtectedTypedefName</b> <i>(string)</i>. Name of the protected typedef. +<li>type => <b>ClassProtectedTypedefType</b> <i>(string)</i>. Data type of the protected typedef. +</ul> +</ul> +</ul> +<li>name => <b>ClassName</b> <i>(string)</i>. Name of the class. +<li>private_members => <b>ClassPrivateMembers</b> <i>(hash)</i>. Information about the private members in the class. +<ul> +<li>members => <b>ClassPrivateMemberList</b> <i>(list)</i>. private member list. +<ul> +<li> <b>ClassPrivateMember</b> <i>(hash)</i>. A private member. +<ul> +<li>protection => <b>ClassPrivateMemberProtection</b> <i>(string)</i>. Protection of the private member. +<li>detailed => <b>ClassPrivateMemberDetailed</b> <i>(hash)</i>. Detailed information about the private member. +<ul> +<li>doc => <b>ClassPrivateMemberDetailedDoc</b> <i>(doc)</i>. Detailed documentation for the private member. +<li>see => <b>ClassPrivateMemberSee</b> <i>(doc)</i>. "See also" documentation for the private member. +</ul> +<li>kind => <b>ClassPrivateMemberKind</b> <i>(string)</i>. Kind of private member (usually "variable"). +<li>name => <b>ClassPrivateMemberName</b> <i>(string)</i>. Name of the private member. +<li>type => <b>ClassPrivateMemberType</b> <i>(string)</i>. Data type of the private member. +</ul> +</ul> +</ul> +<li>private_typedefs => <b>ClassPrivateTypedefs</b> <i>(hash)</i>. Information about the private typedefs in the class. +<ul> +<li>members => <b>ClassPrivateTypedefList</b> <i>(list)</i>. private typedef list. +<ul> +<li> <b>ClassPrivateTypedef</b> <i>(hash)</i>. A private typedef. +<ul> +<li>protection => <b>ClassPrivateTypedefProtection</b> <i>(string)</i>. Protection of the private typedef. +<li>detailed => <b>ClassPrivateTypedefDetailed</b> <i>(hash)</i>. Detailed information about the private typedef. +<ul> +<li>doc => <b>ClassPrivateTypedefDetailedDoc</b> <i>(doc)</i>. Detailed documentation for the private typedef. +<li>see => <b>ClassPrivateTypedefSee</b> <i>(doc)</i>. "See also" documentation for the private typedef. +</ul> +<li>kind => <b>ClassPrivateTypedefKind</b> <i>(string)</i>. Kind of private typedef (usually "typedef"). +<li>name => <b>ClassPrivateTypedefName</b> <i>(string)</i>. Name of the private typedef. +<li>type => <b>ClassPrivateTypedefType</b> <i>(string)</i>. Data type of the private typedef. +</ul> +</ul> +</ul> +<li>protected_methods => <b>ClassProtectedMethods</b> <i>(hash)</i>. Information about the protected methods in the class. +<ul> +<li>members => <b>ClassProtectedMethodList</b> <i>(list)</i>. protected method list. +<ul> +<li> <b>ClassProtectedMethod</b> <i>(hash)</i>. A protected method. +<ul> +<li>parameters => <b>ClassProtectedMethodParams</b> <i>(list)</i>. List of the parameters of the protected method. +<ul> +<li> <b>ClassProtectedMethodParam</b> <i>(hash)</i>. A parameter of the protected method. +<ul> +<li>declaration_name => <b>ClassProtectedMethodParamName</b> <i>(string)</i>. The name of the parameter. +<li>type => <b>ClassProtectedMethodParamType</b> <i>(string)</i>. The data type of the parameter. +</ul> +</ul> +<li>protection => <b>ClassProtectedMethodProtection</b> <i>(string)</i>. Protection of the protected method. +<li>virtualness => <b>ClassProtectedMethodVirtualness</b> <i>(string)</i>. Virtualness of the protected method. +<li>detailed => <b>ClassProtectedMethodDetailed</b> <i>(hash)</i>. Detailed information about the protected method. +<ul> +<li>params => <b>ClassProtectedMethodPDBlocks</b> <i>(list)</i>. List of parameter documentation blocks for the protected method. +<ul> +<li> <b>ClassProtectedMethodPDBlock</b> <i>(hash)</i>. A parameter documentation block for the protected method. +<ul> +<li>parameters => <b>ClassProtectedMethodPDParams</b> <i>(list)</i>. Parameter list for this parameter documentation block. +<ul> +<li> <b>ClassProtectedMethodPDParam</b> <i>(hash)</i>. A parameter documented by this documentation block. +<ul> +<li>name => <b>ClassProtectedMethodPDParamName</b> <i>(string)</i>. Name of the parameter. +</ul> +</ul> +<li>doc => <b>ClassProtectedMethodPDDoc</b> <i>(doc)</i>. Documentation for this parameter documentation block. +</ul> +</ul> +<li>doc => <b>ClassProtectedMethodDetailedDoc</b> <i>(doc)</i>. Detailed documentation for the protected method. +<li>see => <b>ClassProtectedMethodSee</b> <i>(doc)</i>. "See also" documentation for the protected method. +<li>return => <b>ClassProtectedMethodReturn</b> <i>(doc)</i>. Documentation about the return value of the protected method. +</ul> +<li>kind => <b>ClassProtectedMethodKind</b> <i>(string)</i>. Kind of protected method (usually "function"). +<li>name => <b>ClassProtectedMethodName</b> <i>(string)</i>. Name of the protected method. +<li>type => <b>ClassProtectedMethodType</b> <i>(string)</i>. Data type returned by the protected method. +<li>static => <b>ClassProtectedMethodStatic</b> <i>(string)</i>. Whether the protected method is static. +</ul> +</ul> +</ul> +<li>public_typedefs => <b>ClassPublicTypedefs</b> <i>(hash)</i>. Information about the public typedefs in the class. +<ul> +<li>members => <b>ClassPublicTypedefList</b> <i>(list)</i>. public typedef list. +<ul> +<li> <b>ClassPublicTypedef</b> <i>(hash)</i>. A public typedef. +<ul> +<li>protection => <b>ClassPublicTypedefProtection</b> <i>(string)</i>. Protection of the public typedef. +<li>detailed => <b>ClassPublicTypedefDetailed</b> <i>(hash)</i>. Detailed information about the public typedef. +<ul> +<li>doc => <b>ClassPublicTypedefDetailedDoc</b> <i>(doc)</i>. Detailed documentation for the public typedef. +<li>see => <b>ClassPublicTypedefSee</b> <i>(doc)</i>. "See also" documentation for the public typedef. +</ul> +<li>kind => <b>ClassPublicTypedefKind</b> <i>(string)</i>. Kind of public typedef (usually "typedef"). +<li>name => <b>ClassPublicTypedefName</b> <i>(string)</i>. Name of the public typedef. +<li>type => <b>ClassPublicTypedefType</b> <i>(string)</i>. Data type of the public typedef. +</ul> +</ul> +</ul> +<li>public_members => <b>ClassPublicMembers</b> <i>(hash)</i>. Information about the public members in the class. +<ul> +<li>members => <b>ClassPublicMemberList</b> <i>(list)</i>. public member list. +<ul> +<li> <b>ClassPublicMember</b> <i>(hash)</i>. A public member. +<ul> +<li>protection => <b>ClassPublicMemberProtection</b> <i>(string)</i>. Protection of the public member. +<li>detailed => <b>ClassPublicMemberDetailed</b> <i>(hash)</i>. Detailed information about the public member. +<ul> +<li>doc => <b>ClassPublicMemberDetailedDoc</b> <i>(doc)</i>. Detailed documentation for the public member. +<li>see => <b>ClassPublicMemberSee</b> <i>(doc)</i>. "See also" documentation for the public member. +</ul> +<li>kind => <b>ClassPublicMemberKind</b> <i>(string)</i>. Kind of public member (usually "variable"). +<li>name => <b>ClassPublicMemberName</b> <i>(string)</i>. Name of the public member. +<li>type => <b>ClassPublicMemberType</b> <i>(string)</i>. Data type of the public member. +</ul> +</ul> +</ul> +<li>private_methods => <b>ClassPrivateMethods</b> <i>(hash)</i>. Information about the private methods in the class. +<ul> +<li>members => <b>ClassPrivateMethodList</b> <i>(list)</i>. private method list. +<ul> +<li> <b>ClassPrivateMethod</b> <i>(hash)</i>. A private method. +<ul> +<li>parameters => <b>ClassPrivateMethodParams</b> <i>(list)</i>. List of the parameters of the private method. +<ul> +<li> <b>ClassPrivateMethodParam</b> <i>(hash)</i>. A parameter of the private method. +<ul> +<li>declaration_name => <b>ClassPrivateMethodParamName</b> <i>(string)</i>. The name of the parameter. +<li>type => <b>ClassPrivateMethodParamType</b> <i>(string)</i>. The data type of the parameter. +</ul> +</ul> +<li>protection => <b>ClassPrivateMethodProtection</b> <i>(string)</i>. Protection of the private method. +<li>virtualness => <b>ClassPrivateMethodVirtualness</b> <i>(string)</i>. Virtualness of the private method. +<li>detailed => <b>ClassPrivateMethodDetailed</b> <i>(hash)</i>. Detailed information about the private method. +<ul> +<li>params => <b>ClassPrivateMethodPDBlocks</b> <i>(list)</i>. List of parameter documentation blocks for the private method. +<ul> +<li> <b>ClassPrivateMethodPDBlock</b> <i>(hash)</i>. A parameter documentation block for the private method. +<ul> +<li>parameters => <b>ClassPrivateMethodPDParams</b> <i>(list)</i>. Parameter list for this parameter documentation block. +<ul> +<li> <b>ClassPrivateMethodPDParam</b> <i>(hash)</i>. A parameter documented by this documentation block. +<ul> +<li>name => <b>ClassPrivateMethodPDParamName</b> <i>(string)</i>. Name of the parameter. +</ul> +</ul> +<li>doc => <b>ClassPrivateMethodPDDoc</b> <i>(doc)</i>. Documentation for this parameter documentation block. +</ul> +</ul> +<li>doc => <b>ClassPrivateMethodDetailedDoc</b> <i>(doc)</i>. Detailed documentation for the private method. +<li>see => <b>ClassPrivateMethodSee</b> <i>(doc)</i>. "See also" documentation for the private method. +<li>return => <b>ClassPrivateMethodReturn</b> <i>(doc)</i>. Documentation about the return value of the private method. +</ul> +<li>kind => <b>ClassPrivateMethodKind</b> <i>(string)</i>. Kind of private method (usually "function"). +<li>name => <b>ClassPrivateMethodName</b> <i>(string)</i>. Name of the private method. +<li>type => <b>ClassPrivateMethodType</b> <i>(string)</i>. Data type returned by the private method. +<li>static => <b>ClassPrivateMethodStatic</b> <i>(string)</i>. Whether the private method is static. +</ul> +</ul> +</ul> +<li>public_methods => <b>ClassPublicMethods</b> <i>(hash)</i>. Information about the public methods in the class. +<ul> +<li>members => <b>ClassPublicMethodList</b> <i>(list)</i>. public method list. +<ul> +<li> <b>ClassPublicMethod</b> <i>(hash)</i>. A public method. +<ul> +<li>parameters => <b>ClassPublicMethodParams</b> <i>(list)</i>. List of the parameters of the public method. +<ul> +<li> <b>ClassPublicMethodParam</b> <i>(hash)</i>. A parameter of the public method. +<ul> +<li>declaration_name => <b>ClassPublicMethodParamName</b> <i>(string)</i>. The name of the parameter. +<li>type => <b>ClassPublicMethodParamType</b> <i>(string)</i>. The data type of the parameter. +</ul> +</ul> +<li>protection => <b>ClassPublicMethodProtection</b> <i>(string)</i>. Protection of the public method. +<li>virtualness => <b>ClassPublicMethodVirtualness</b> <i>(string)</i>. Virtualness of the public method. +<li>detailed => <b>ClassPublicMethodDetailed</b> <i>(hash)</i>. Detailed information about the public method. +<ul> +<li>params => <b>ClassPublicMethodPDBlocks</b> <i>(list)</i>. List of parameter documentation blocks for the public method. +<ul> +<li> <b>ClassPublicMethodPDBlock</b> <i>(hash)</i>. A parameter documentation block for the public method. +<ul> +<li>parameters => <b>ClassPublicMethodPDParams</b> <i>(list)</i>. Parameter list for this parameter documentation block. +<ul> +<li> <b>ClassPublicMethodPDParam</b> <i>(hash)</i>. A parameter documented by this documentation block. +<ul> +<li>name => <b>ClassPublicMethodPDParamName</b> <i>(string)</i>. Name of the parameter. +</ul> +</ul> +<li>doc => <b>ClassPublicMethodPDDoc</b> <i>(doc)</i>. Documentation for this parameter documentation block. +</ul> +</ul> +<li>doc => <b>ClassPublicMethodDetailedDoc</b> <i>(doc)</i>. Detailed documentation for the public method. +<li>see => <b>ClassPublicMethodSee</b> <i>(doc)</i>. "See also" documentation for the public method. +<li>return => <b>ClassPublicMethodReturn</b> <i>(doc)</i>. Documentation about the return value of the public method. +</ul> +<li>kind => <b>ClassPublicMethodKind</b> <i>(string)</i>. Kind of public method (usually "function"). +<li>name => <b>ClassPublicMethodName</b> <i>(string)</i>. Name of the public method. +<li>type => <b>ClassPublicMethodType</b> <i>(string)</i>. Data type returned by the public method. +<li>static => <b>ClassPublicMethodStatic</b> <i>(string)</i>. Whether the public method is static. +</ul> +</ul> +</ul> +</ul> +</ul> +<li>files => <b>Files</b> <i>(list)</i>. Documented files. +<ul> +<li> <b>File</b> <i>(hash)</i>. A documented file. +<ul> +<li>detailed => <b>FileDetailed</b> <i>(hash)</i>. Detailed information about the file. +<ul> +<li>doc => <b>FileDetailedDoc</b> <i>(doc)</i>. Detailed documentation block for the file. +</ul> +<li>functions => <b>FileFunctions</b> <i>(hash)</i>. Information about the functions in the file. +<ul> +<li>members => <b>FileFunctionList</b> <i>(list)</i>. function list. +<ul> +<li> <b>FileFunction</b> <i>(hash)</i>. A function. +<ul> +<li>parameters => <b>FileFunctionParams</b> <i>(list)</i>. List of the parameters of the function. +<ul> +<li> <b>FileFunctionParam</b> <i>(hash)</i>. A parameter of the function. +<ul> +<li>declaration_name => <b>FileFunctionParamName</b> <i>(string)</i>. The name of the parameter. +<li>type => <b>FileFunctionParamType</b> <i>(string)</i>. The data type of the parameter. +</ul> +</ul> +<li>protection => <b>FileFunctionProtection</b> <i>(string)</i>. Protection of the function. +<li>virtualness => <b>FileFunctionVirtualness</b> <i>(string)</i>. Virtualness of the function. +<li>detailed => <b>FileFunctionDetailed</b> <i>(hash)</i>. Detailed information about the function. +<ul> +<li>params => <b>FileFunctionPDBlocks</b> <i>(list)</i>. List of parameter documentation blocks for the function. +<ul> +<li> <b>FileFunctionPDBlock</b> <i>(hash)</i>. A parameter documentation block for the function. +<ul> +<li>parameters => <b>FileFunctionPDParams</b> <i>(list)</i>. Parameter list for this parameter documentation block. +<ul> +<li> <b>FileFunctionPDParam</b> <i>(hash)</i>. A parameter documented by this documentation block. +<ul> +<li>name => <b>FileFunctionPDParamName</b> <i>(string)</i>. Name of the parameter. +</ul> +</ul> +<li>doc => <b>FileFunctionPDDoc</b> <i>(doc)</i>. Documentation for this parameter documentation block. +</ul> +</ul> +<li>doc => <b>FileFunctionDetailedDoc</b> <i>(doc)</i>. Detailed documentation for the function. +<li>see => <b>FileFunctionSee</b> <i>(doc)</i>. "See also" documentation for the function. +<li>return => <b>FileFunctionReturn</b> <i>(doc)</i>. Documentation about the return value of the function. +</ul> +<li>kind => <b>FileFunctionKind</b> <i>(string)</i>. Kind of function (usually "function"). +<li>name => <b>FileFunctionName</b> <i>(string)</i>. Name of the function. +<li>type => <b>FileFunctionType</b> <i>(string)</i>. Data type returned by the function. +<li>static => <b>FileFunctionStatic</b> <i>(string)</i>. Whether the function is static. +</ul> +</ul> +</ul> +<li>name => <b>FileName</b> <i>(string)</i>. Name of the file. +<li>variables => <b>FileVariables</b> <i>(hash)</i>. Information about the variables in the file. +<ul> +<li>members => <b>FileVariableList</b> <i>(list)</i>. variable list. +<ul> +<li> <b>FileVariable</b> <i>(hash)</i>. A variable. +<ul> +<li>protection => <b>FileVariableProtection</b> <i>(string)</i>. Protection of the variable. +<li>detailed => <b>FileVariableDetailed</b> <i>(hash)</i>. Detailed information about the variable. +<ul> +<li>doc => <b>FileVariableDetailedDoc</b> <i>(doc)</i>. Detailed documentation for the variable. +<li>see => <b>FileVariableSee</b> <i>(doc)</i>. "See also" documentation for the variable. +</ul> +<li>kind => <b>FileVariableKind</b> <i>(string)</i>. Kind of variable (usually "variable"). +<li>name => <b>FileVariableName</b> <i>(string)</i>. Name of the variable. +<li>type => <b>FileVariableType</b> <i>(string)</i>. Data type of the variable. +</ul> +</ul> +</ul> +<li>typedefs => <b>FileTypedefs</b> <i>(hash)</i>. Information about the typedefs in the file. +<ul> +<li>members => <b>FileTypedefList</b> <i>(list)</i>. typedef list. +<ul> +<li> <b>FileTypedef</b> <i>(hash)</i>. A typedef. +<ul> +<li>protection => <b>FileTypedefProtection</b> <i>(string)</i>. Protection of the typedef. +<li>detailed => <b>FileTypedefDetailed</b> <i>(hash)</i>. Detailed information about the typedef. +<ul> +<li>doc => <b>FileTypedefDetailedDoc</b> <i>(doc)</i>. Detailed documentation for the typedef. +<li>see => <b>FileTypedefSee</b> <i>(doc)</i>. "See also" documentation for the typedef. +</ul> +<li>kind => <b>FileTypedefKind</b> <i>(string)</i>. Kind of typedef (usually "typedef"). +<li>name => <b>FileTypedefName</b> <i>(string)</i>. Name of the typedef. +<li>type => <b>FileTypedefType</b> <i>(string)</i>. Data type of the typedef. +</ul> +</ul> +</ul> +</ul> +</ul> +</ul> +</ul> \htmlonly Go to the <a href="arch.html">next</a> section or return to the |