Clownfish::DocuComment - Formatted comment a la Doxygen.
my $text = <<'END_COMMENT'; /** Brief description. * * Start the long description. More long description. * * @param foo A Foo. * @param bar A Bar. * @return a return value. */ END_COMMENT my $docucomment = Clownfish::DocuComment->parse($text);
my $self = Clownfish::DocuComment->parse($text);
Parse comment text.
my $self = Clownfish::DocuComment->new( description => "Brief. Start long. More long.", brief => "Brief.", long => "Long start. More long.", param_names => \@param_names, param_docs => \@param_docs, retval => "a return value." );
description - The complete description.
brief - The first sentence of the description (a "brief" description).
long - The description minus the first sentence.
param_names - An array of param names.
param_docs - An array containing a blurb for each param name.
retval - Return value.
Accessors.
Copyright 2008-2010 Marvin Humphrey
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install KSx::Simple, copy and paste the appropriate command in to your terminal.
cpanm
cpanm KSx::Simple
CPAN shell
perl -MCPAN -e shell install KSx::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.