diff options
| author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2002-10-30 20:57:53 (GMT) |
|---|---|---|
| committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2002-10-30 20:57:53 (GMT) |
| commit | c6d6555a949e86be5c859311eb4db5dcc092c258 (patch) | |
| tree | dd06bd100b0bd88b6ee40c8464efac800a749c32 /doc | |
| parent | 7c34dd2b1594925d0a012e9ba290bf9c80574db5 (diff) | |
| download | Doxygen-c6d6555a949e86be5c859311eb4db5dcc092c258.zip Doxygen-c6d6555a949e86be5c859311eb4db5dcc092c258.tar.gz Doxygen-c6d6555a949e86be5c859311eb4db5dcc092c258.tar.bz2 | |
Release-1.2.18-20021030
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile | 3 | ||||
| -rw-r--r-- | doc/doxygen_manual.tex | 2 | ||||
| -rw-r--r-- | doc/faq.doc | 34 | ||||
| -rw-r--r-- | doc/index.doc | 3 | ||||
| -rw-r--r-- | doc/install.doc | 14 | ||||
| -rw-r--r-- | doc/language.doc | 22 | ||||
| -rw-r--r-- | doc/perlmod.doc | 190 | ||||
| -rw-r--r-- | doc/perlmod_tree.doc | 377 |
8 files changed, 617 insertions, 28 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile index e4cb868..c25878e 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -36,7 +36,8 @@ INPUT = index.doc install.doc starting.doc docblocks.doc lists.doc \ doxygen_usage.doc doxytag_usage.doc doxysearch_usage.doc \ doxywizard_usage.doc \ installdox_usage.doc output.doc autolink.doc \ - config.doc commands.doc htmlcmds.doc language.doc arch.doc + config.doc commands.doc htmlcmds.doc language.doc \ + perlmod.doc perlmod_tree.doc arch.doc FILE_PATTERNS = *.cpp *.h *.doc EXAMPLE_PATH = ../examples RECURSIVE = NO diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex index 91a6764..ffac9a7 100644 --- a/doc/doxygen_manual.tex +++ b/doc/doxygen_manual.tex @@ -72,6 +72,8 @@ Written by Dimitri van Heesch\\[2ex] \input{htmlcmds} \part{Developers Manual} \input{arch} +\input{perlmod} +%\input{perlmod_tree} \input{langhowto} \printindex \end{document} diff --git a/doc/faq.doc b/doc/faq.doc index 4f7ce54..7a85be4 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -62,7 +62,7 @@ PREDEFINED = MY_MACRO()= manual for more information. </ol> -<li><b>When I set EXTRACT_ALL to NO non of my functions are shown in the documentation.</b></li> +<li><b>When I set EXTRACT_ALL to NO none of my functions are shown in the documentation.</b></li> In order for global functions, variables, enums, typedefs, and defines to be documented you should document the file in which these commands are @@ -111,9 +111,9 @@ in the documentation of the class MyClassName regardless of the name of the actu header file in which the definition of MyClassName is contained. If you want doxygen to show that the include file should be included using -brackets you should type: +quotes instead of angle brackets you should type: \verbatim -/*! \class MyClassName include.h "path/include.h" +/*! \class MyClassName myhdr.h "path/myhdr.h" * * Docs for MyClassName */ @@ -187,18 +187,36 @@ EXCLUDE_PATTERNS = */test/* Put a \% in front of the class name. Like this: \%MyClass. Doxygen will then remove the % and keep the word unlinked. +<li><b>My favourite programming language is X. Can I still use doxygen?</b> + +No, not as such; doxygen needs to understand the structure of what it reads. +If you don't mind spending some time on it, there are several options: +- If the grammer of X is close to C or C++, then it is probably not too hard to + tweak src/scanner.l a bit so the language is supported. This is done + for all other languages directly supported by doxygen + (i.e. Java, IDL, C#, PHP). +- If the grammer of X is somewhat different than you can write an input + filter that translates X into something similar enough to C/C++ for + doxygen to understand (this approach is taken for VB, Object Pascal, and + Javascript, see http://www.stack.nl/~dimitri/doxygen/download.html#helpers). +- If the grammer is completely different one could write a parser for X and + write a backend that produces a similar syntax tree as is done by + src/scanner.l (and also by src/tagreader.cpp while reading tag files). + <li><b>Help! I get the cryptic message "input buffer overflow, can't enlarge buffer because scanner uses REJECT"</b> -This error happens when doxygen lexical scanner has a rules that matches -more than 16K input character in one go. I've seen this happening +This error happens when doxygen lexical scanner has a rule that matches +more than 16K of input characters in one go. I've seen this happening on a very large generated file (\>16K lines), where the built-in preprocessor converted it into an empty file (with \>16K of newlines). Another case where this might happen is if you have lines in your code with more than 16K characters. -If you have ran into such a case and want me to fix it, you -should send me a code fragment that triggers the message. +If you have run into such a case and want me to fix it, you +should send me a code fragment that triggers the message. The workaround +the problem put some line-breaks into your file, split it up into smaller +parts, or exclude it from the input using EXCLUDE. <li><b>How did doxygen get its name?</b> @@ -211,7 +229,7 @@ generator -> gen \endverbatim At the time I was looking into lex and yacc, where a lot of things start with -"yy", so the "y" slipped in and made things pronouncable. +"yy", so the "y" slipped in and made things pronounceable. <li><b>What was the reason to develop doxygen?</b> diff --git a/doc/index.doc b/doc/index.doc index 130922d..b04cc8a 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -27,7 +27,7 @@ Version: $(VERSION) <h2>Introduction</h2> Doxygen is a documentation system for C++, C, Java, IDL -(Corba, Microsoft, and KDE-DCOP flavors) and to some extent PHP. +(Corba, Microsoft, and KDE-DCOP flavors) and to some extent PHP and C#. It can help you in three ways: <ol> @@ -105,6 +105,7 @@ The third part provides information for developers: <ul> <li>Section \ref arch gives a global overview of how doxygen is internally structured. +<li>Section \ref perlmod shows how to use the PerlMod output. <li>Section \ref langhowto explains how to add support for new output languages. </ul> diff --git a/doc/install.doc b/doc/install.doc index 1387f13..3bba13e 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -557,15 +557,15 @@ http://www.trolltech.com/products/download/qt-win-noncomm.html Doxygen was developed and tested under Linux using the following open-source tools: <ul> -<li>EGCS version 2.91.66 +<li>GCC version 2.95.3 <li>GNU flex version 2.5.4 -<li>GNU bison version 1.25 -<li>GNU make version 3.76.1 -<li>Perl version 5.005_02 -<li>VIM version 5.4 -<li>Netscape 4.61 +<li>GNU bison version 1.35 +<li>GNU make version 3.79.1 +<li>Perl version 5.005_03 +<li>VIM version 5.8 +<li>Mozilla 1.0 <li>Troll Tech's tmake version 1.3 (included in the distribution) -<li>teTeX version 0.9 +<li>teTeX version 1.0 <li>CVS 1.10.7 </ul> diff --git a/doc/language.doc b/doc/language.doc index 1df07fe..c3e2fda 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -25,7 +25,7 @@ Doxygen has built-in support for multiple languages. This means that the text fragments that doxygen generates can be produced in languages other than English (the default) at configuration time. -Currently (version 1.2.14-20020317), 28 languages +Currently (version 1.2.18-20021020), 28 languages are supported (sorted alphabetically): Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, @@ -79,7 +79,7 @@ when the translator was updated. <TD>Croatian</TD> <TD>Boris Bralo</TD> <TD>boris.bralo@NOSPAM.zg.tel.hr</TD> - <TD>up-to-date</TD> + <TD>1.2.18</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Czech</TD> @@ -139,13 +139,13 @@ when the translator was updated. <TD>Italian</TD> <TD>Alessandro Falappa<br>Ahmed Aldo Faisal</TD> <TD>alessandro@NOSPAM.falappa.net<br>aaf23@NOSPAM.cam.ac.uk</TD> - <TD>up-to-date</TD> + <TD>1.2.18</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Japanese</TD> <TD>Ryunosuke Sato<br>Kenji Nagamatsu</TD> <TD>puyo@NOSPAM.mint.freemail.ne.jp<br>naga@NOSPAM.joyful.club.ne.jp</TD> - <TD>up-to-date</TD> + <TD>1.2.18</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Korean</TD> @@ -169,7 +169,7 @@ when the translator was updated. <TD>Portuguese</TD> <TD>Rui Godinho Lopes</TD> <TD>ruiglopes@NOSPAM.yahoo.com</TD> - <TD>up-to-date</TD> + <TD>1.2.18</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Romanian</TD> @@ -193,7 +193,7 @@ when the translator was updated. <TD>Slovak</TD> <TD>Stanislav Kudláč</TD> <TD>skudlac@NOSPAM.pobox.sk</TD> - <TD>up-to-date</TD> + <TD>1.2.18</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Slovene</TD> @@ -239,7 +239,7 @@ when the translator was updated. \hline Chinese Traditional & Gary Lee & {\tt garylee@ecosine.com.tw} & 1.2.16 \\ \hline - Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & up-to-date \\ + Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & 1.2.18 \\ \hline Czech & Petr P\v{r}ikryl & {\tt prikrylp@skil.cz} & up-to-date \\ \hline @@ -260,10 +260,10 @@ when the translator was updated. \hline Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt foldvari@diatronltd.com} & 1.2.1 \\ \hline - Italian & Alessandro Falappa & {\tt alessandro@falappa.net} & up-to-date \\ + Italian & Alessandro Falappa & {\tt alessandro@falappa.net} & 1.2.18 \\ & Ahmed Aldo Faisal & {\tt aaf23@cam.ac.uk} & \\ \hline - Japanese & Ryunosuke Sato & {\tt puyo@mint.freemail.ne.jp} & up-to-date \\ + Japanese & Ryunosuke Sato & {\tt puyo@mint.freemail.ne.jp} & 1.2.18 \\ & Kenji Nagamatsu & {\tt naga@joyful.club.ne.jp} & \\ \hline Korean & Richard Kim & {\tt ryk@dspwiz.com} & 1.2.13 \\ @@ -273,7 +273,7 @@ when the translator was updated. Polish & Piotr Kaminski & {\tt Piotr.Kaminski@ctm.gdynia.pl} & 1.2.17 \\ & Grzegorz Kowal & {\tt g\_kowal@poczta.onet.pl} & \\ \hline - Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & up-to-date \\ + Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & 1.2.18 \\ \hline Romanian & Alexandru Iosup & {\tt aiosup@yahoo.com} & 1.2.16 \\ \hline @@ -281,7 +281,7 @@ when the translator was updated. \hline Serbian & Dejan Milosavljevic & {\tt dmilos@email.com} & 1.2.17 \\ \hline - Slovak & Stanislav Kudl\'{a}\v{c} & {\tt skudlac@pobox.sk} & up-to-date \\ + Slovak & Stanislav Kudl\'{a}\v{c} & {\tt skudlac@pobox.sk} & 1.2.18 \\ \hline Slovene & Matjaz Ostroversnik & {\tt matjaz.ostroversnik@zrs-tk.si} & 1.2.16 \\ \hline diff --git a/doc/perlmod.doc b/doc/perlmod.doc new file mode 100644 index 0000000..becbdf2 --- /dev/null +++ b/doc/perlmod.doc @@ -0,0 +1,190 @@ +/*! \page perlmod Perl Module output format documentation + +\addindex perlmod + +<p>Since version 1.2.18, Doxygen can generate a new output format we +have called the "Perl Module output format". It has been +designed as an intermediate format that can be used to generate new +and customized output without having to modify the Doxygen source. +Therefore, its purpose is similar to the XML output format that can be +also generated by Doxygen. The XML output format is more standard, +but the Perl Module output format is possibly simpler and easier to +use. + +<p>The Perl Module output format is still experimental at the moment +and could be changed in incompatible ways in future versions, although +this should not be very probable. It is also lacking some features of +other Doxygen backends. However, it can be already used to generate +useful output, as shown by the Perl Module-based LaTeX generator. + +<p>Please report any bugs or problems you find in the Perl Module +backend or the Perl Module-based LaTeX generator to the +doxygen-develop mailing list. Suggestions are welcome as well. + +\section using_perlmod_fmt Using the Perl Module output format. + +<p>When the <b>GENERATE_PERLMOD</b> tag is enabled in the Doxyfile, +running Doxygen generates a number of files in the <b>perlmod/</b> +subdirectory of your output directory. These files are the following: + +<ul> + +<li><b>DoxyDocs.pm</b>. This is the Perl module that actually +contains the documentation, in the Perl Module format described +\ref doxydocs_format "below". + +<li><b>DoxyModel.pm</b>. This Perl module describes the structure of +<b>DoxyDocs.pm</b>, independently of the actual documentation. See +\ref doxymodel_format "below" for details. + +<li><b>doxyrules.make</b>. This file contains the make rules to build +and clean the files that are generated from the Doxyfile. Also +contains the paths to those files and other relevant information. This +file is intended to be included by your own Makefile. + +<li><b>Makefile</b>. This is a simple Makefile including +<b>doxyrules.make</b>. + +</ul> + +<p>To make use of the documentation stored in DoxyDocs.pm you can use +one of the default Perl Module-based generators provided by Doxygen +(at the moment this includes the Perl Module-based LaTeX generator, +see \ref perlmod_latex "below") or write your own customized +generator. This should not be too hard if you have some knowledge of +Perl and it's the main purpose of including the Perl Module backend in +Doxygen. See \ref doxydocs_format "below" for details on how +to do this. + +\section perlmod_latex Using the Perl Module-based LaTeX generator. + +<p>The Perl Module-based LaTeX generator is pretty experimental and +incomplete at the moment, but you could find it useful nevertheless. +It can generate documentation for functions, typedefs and variables +within files and classes and can be customized quite a lot by +redefining TeX macros. However, there is still no documentation on +how to do this. + +<p>Setting the <b>PERLMOD_LATEX</b> tag to <b>YES</b> in the Doxyfile +enables the creation of some additional files in the <b>perlmod/</b> +subdirectory of your output directory. These files contain the Perl +scripts and LaTeX code necessary to generate PDF and DVI output from +the Perl Module output, using PDFLaTeX and LaTeX respectively. Rules +to automate the use of these files are also added to +<b>doxyrules.make</b> and the <b>Makefile</b>. + +<p>The additional generated files are the following: + +<ul> + +<li><b>doxylatex.pl</b>. This Perl script uses DoxyDocs.pm and +DoxyModel.pm to generate <b>doxydocs.tex</b>, a TeX file containing +the documentation in a format that can be accessed by LaTeX code. This +file is not directly LaTeXable. + +<li><b>doxyformat.tex</b>. This file contains the LaTeX code that +transforms the documentation from doxydocs.tex into LaTeX text +suitable to be LaTeX'ed and presented to the user. + +<li><b>doxylatex-template.pl</b>. This Perl script uses DoxyModel.pm +to generate <b>doxytemplate.tex</b>, a TeX file defining default +values for some macros. doxytemplate.tex is included by +doxyformat.tex to avoid the need of explicitly defining some macros. + +<li><b>doxylatex.tex</b>. This is a very simple LaTeX document that +loads some packages and includes doxyformat.tex and doxydocs.tex. This +document is LaTeX'ed to produce the PDF and DVI documentation by the +rules added to <b>doxyrules.make</b>. + +</ul> + +\subsection pm_pdf_gen Simple creation of PDF and DVI output using the Perl Module-based LaTeX generator. + +<p>To try this you need to have installed LaTeX, PDFLaTeX and the +packages used by <b>doxylatex.tex</b>. + +<ol> + +<li>Update your Doxyfile to the latest version using: + +<pre>doxygen -u Doxyfile</pre> + +<li>Set both <b>GENERATE_PERLMOD</b> and <b>PERLMOD_LATEX</b> tags to +YES in your Doxyfile. + +<li>Run Doxygen on your Doxyfile: + +<pre>doxygen Doxyfile</pre> + +<li>A <b>perlmod/</b> subdirectory should have appeared in your output +directory. Enter the <b>perlmod/</b> subdirectory and run: + +<pre>make pdf</pre> + +<p>This should generate a <b>doxylatex.pdf</b> with the documentation +in PDF format. + +<li>Run: + +<pre>make dvi</pre> + +<p>This should generate a <b>doxylatex.dvi</b> with the documentation +in DVI format. + +</ol> + +\section doxydocs_format Perl Module documentation format. + +<p>The Perl Module documentation generated by Doxygen is stored in +<b>DoxyDocs.pm</b>. This is a very simple Perl module that contains +only two statements: an assigment to the variable <b>$doxydocs</b> and +the customary <b>1;</b> statement which usually ends Perl modules. +The documentation is stored in the variable <b>$doxydocs</b>, which +can then be accessed by a Perl script using <b>DoxyDocs.pm</b>. + +<p><b>$doxydocs</b> contains a tree-like structure composed of three +types of nodes: strings, hashes and lists. + +<ul> + +<li><b>Strings</b>. These are normal Perl strings. They can be of +any length can contain any character. Their semantics depends on +their location within the tree. This type of node has no children. + +<li><b>Hashes</b>. These are references to anonymous Perl hashes. A +hash can have multiple fields, each with a different key. The value +of a hash field can be a string, a hash or a list, and its semantics +depends on the key of the hash field and the location of the hash +within the tree. The values of the hash fields are the children of +the node. + +<li><b>Lists</b>. These are references to anonymous Perl lists. A +list has an undefined number of elements, which are the children of +the node. Each element has the same type (string, hash or list) and +the same semantics, depending on the location of the list within the +tree. + +</ul> + +<p>As you can see, the documentation contained in <b>$doxydocs</b> +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 <b>$doxydocs</b> 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 describing the Perl Module documentation tree. + +<p>You might be interested in processing the documentation contained +in <b>DoxyDocs.pm</b> without needing to take into account the +semantics of each node of the documentation tree. For this purpose, +Doxygen generates a <b>DoxyModel.pm</b> file which contains a data +structure describing the type and children of each node in the +documentation tree. + +<p>The rest of this section is to be written yet, but in the meantime +you can look at the Perl scripts generated by Doxygen (such as +<b>doxylatex.pl</b> or <b>doxytemplate-latex.pl</b>) to get an idea on +how to use <b>DoxyModel.pm</b>. + +*/ diff --git a/doc/perlmod_tree.doc b/doc/perlmod_tree.doc new file mode 100644 index 0000000..0d412ba --- /dev/null +++ b/doc/perlmod_tree.doc @@ -0,0 +1,377 @@ +/*! \page perlmod_tree Nodes in the documentation tree of the Perl Module output format + +<h2>Nodes in the documentation tree of the Perl Module output +format.</h2> + +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> + +*/ |