Marcel Grünauer > Sub-Documentation > Sub::Documentation::Attributes

Download:
Sub-Documentation-1.100880.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.100880   Source  

NAME ^

Sub::Documentation::Attributes - Use attributes to declare documentation

VERSION ^

version 1.100880

SYNOPSIS ^

    use Sub::Documentation::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

FUNCTIONS ^

add_attr_doc

This is the attribute handler for all attributes.

INSTALLATION ^

See perlmodinstall for information and options on installing Perl modules.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests through the web interface at http://rt.cpan.org/Public/Dist/Display.html?Name=Sub-Documentation.

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

The development version lives at http://github.com/hanekomu/Sub-Documentation/. Instead of sending patches, please fork this project using the standard git and github infrastructure.

AUTHOR ^

  Marcel Gruenauer <marcel@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2010 by Marcel Gruenauer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: