In Perl that is a lot harder to do so I have added a and structural indicator so that they can be documented separately. In other languages the Doxygen structural indicator is used to document subroutines/functions/methods and the parsing engine figures out what is what. A comment block must have continuous "#" comment markers as a blank line can be used as a termination mark for the doxygen comment block.
You can also start comment blocks with "#" and end comment blocks with a blank line or real code, this allows you to place comments right next to the subroutines that they refer to if you wish. The following Doxygen style comment is the preferred block style, though others are supported and are listed below: #** doc/html/ directory inside of your project root. Example: /home/jordan/workspace/PerlDoxygen/trunk/> doxygen DoxyfileĪll of your documentation will be in the. Once you have done this you can simply run the following from the root of your project to document your Perl scripts or methods. home/jordan/workspace/PerlDoxygen/trunk/lib/Doxygen/Filter/Perl.pm Example: /home/jordan/workspace/PerlDoxygen/trunk/Doxyfile
#DOXYGEN METHOD COMMENT HOW TO#
Please see the Doxygen manual for information on how to configure the Doxyfile via a text editor or with the doxywizard tool. You can edit this file with the doxywizard tool if you so desire or if you need to change the lib directory location or the output location (the default output is. This file will have all of the presets needed for documenting Perl code. Example: /usr/local/bin/doxygen-filter-perlĬopy over the Doxyfile file from this project into the root directory of your project so that it is at the same level as your lib directory. Make sure that the doxygen-filter-perl script was copied from this project into your path somewhere and that it has RX permissions.
#DOXYGEN METHOD COMMENT INSTALL#
If you install from source then do: perl Makefile.PL
Install Doxygen::Filter::Perl via CPAN or from source. The Doxgyen style comment blocks for methods/functions can be inside or outside the method/function. We plan on supporting most Doxygen style comments and POD (plain old documentation) style comments. The Doxygen::Filter::Perl module is designed to provide support for documenting perl scripts and modules to be used with the Doxygen engine. Documenting Subroutines/Functions/Methodsĭoxygen::Filter::Perl - A perl code pre-filter for Doxygen DESCRIPTION.Support Style Options and Section Indicators.
0 kommentar(er)
