diff options
Diffstat (limited to 'doc/perlmod.doc')
| -rw-r--r-- | doc/perlmod.doc | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/perlmod.doc b/doc/perlmod.doc index 8616dc6..3d2e2c2 100644 --- a/doc/perlmod.doc +++ b/doc/perlmod.doc @@ -2,19 +2,19 @@ \addindex perlmod -<p>Since version 1.2.18, Doxygen can generate a new output format we +<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. +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, +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 +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 @@ -24,7 +24,7 @@ doxygen-develop mailing list. Suggestions are welcome as well. \section using_perlmod_fmt Usage <p>When the \ref cfg_generate_perlmod "GENERATE_PERLMOD" tag is enabled in the Doxyfile, -running Doxygen generates a number of files in the `perlmod/` +running doxygen generates a number of files in the `perlmod/` subdirectory of your output directory. These files are the following: <ul> @@ -48,12 +48,12 @@ file is intended to be included by your own Makefile. </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 +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 +doxygen. See \ref doxydocs_format "below" for details on how to do this. <-- want to use \LaTeX but not possible in headings --> @@ -114,7 +114,7 @@ packages used by `doxylatex.tex`. \ref cfg_perlmod_latex "PERLMOD_LATEX" tags to \c YES in your Doxyfile. -<li>Run Doxygen on your Doxyfile: +<li>Run doxygen on your Doxyfile: <pre>doxygen Doxyfile</pre> @@ -137,7 +137,7 @@ in DVI format. \section doxydocs_format Documentation format. -<p>The Perl Module documentation generated by Doxygen is stored in +<p>The Perl Module documentation generated by doxygen is stored in `DoxyDocs.pm`. This is a very simple Perl module that contains only two statements: an assignment to the variable `$doxydocs` and the customary `1;` statement which usually ends Perl modules. @@ -183,12 +183,12 @@ present in \ref perlmod_tree "this page". <p>You might be interested in processing the documentation contained in `DoxyDocs.pm` without needing to take into account the semantics of each node of the documentation tree. For this purpose, -Doxygen generates a `DoxyModel.pm` file which contains a data +doxygen generates a `DoxyModel.pm` 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 +you can look at the Perl scripts generated by doxygen (such as `doxylatex.pl` or `doxytemplate-latex.pl`) to get an idea on how to use `DoxyModel.pm`. |