Pod::Generated::Attributes - use attributes to declare documentation
use Pod::Generated::Attributes; sub say : Purpose(prints its arguments, appending a newline) : Param(@text; the text to be printed) : Deprecated(use Perl6::Say instead) { my $self = shift; print @_, "\n"; }
This module provides attributes so you can declare documentation with the subroutine or variable you are documenting.
The following attributes are provided:
Purpose
Id
Author
Param
Returns
Throws
Example
Default
More documentation will follow.
If you talk about this module in blogs, on delicious.com or anywhere else, please use the podgenerated tag.
podgenerated
No bugs have been reported.
Please report any bugs or feature requests to bug-pod-generated@rt.cpan.org, or through the web interface at http://rt.cpan.org.
bug-pod-generated@rt.cpan.org
See perlmodinstall for information and options on installing Perl modules.
The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see http://search.cpan.org/dist/Pod-Generated/.
Marcel Grünauer, <marcel@cpan.org>
<marcel@cpan.org>
Copyright 2007-2009 by Marcel Grünauer
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Pod::Generated, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Generated
CPAN shell
perl -MCPAN -e shell install Pod::Generated
For more information on module installation, please visit the detailed CPAN module installation guide.