in reply to Re^2: Doxygen Perl Filter on Windows
in thread Doxygen Perl Filter on Windows
Have you tried looking at the documentation on CPAN for this? http://search.cpan.org/~jordan/Doxygen-Filter-Perl-1.00/lib/Doxygen/Filter/Perl.pm Have you asked this question on the Doxygen::Filter::Perl discussions board on SF?
There are few things you need to do to make this work.
Then all you need to do is run "doxygen.exe Doxyfile" and it will generate some html output for you. The CPAN docs say that what this does is generate C like documentation out of the perl code/model so that doxygen can understand it. Thus a "use" command is turned in to a #include. This will make all of the inheritance diagrams work right and do some pretty cool things for documenting your perl code.
As far as documenting a subroutine, once again, look at the Docs on CPAN.
#** @function public subnamedfoo ($var, $foo, $bar)
# This function subnamedfoo does XYZ
# and it does some more of this and that
# @params var required this value is for xyz
# @params foo required this value is for abc
# @params bar optional this is not really needed for xyz
# @retval retval this is a string that does bla
#*
sub subnamedfoo {
my $var = shift;
my $foo = shift;
my $bar = shift;
#..... do something ......
return $retval;
}
|
|---|
| Replies are listed 'Best First'. | |
|---|---|
|
Re^4: Doxygen Perl Filter on Windows
by Anonymous Monk on Dec 28, 2011 at 06:39 UTC |