NAME

Pod::Generated::Attributes - use attributes to declare documentation

SYNOPSIS

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";
}

DESCRIPTION

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.

TAGS

If you talk about this module in blogs, on delicious.com or anywhere else, please use the podgenerated tag.

BUGS AND LIMITATIONS

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.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY

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/.

AUTHOR

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE

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.