Maxim Grigoriev > POD-Credentials > POD::Credentials

Download:
POD-Credentials-0.04.tgz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.04   Source  

NAME ^

POD::Credentials - POD credentials OO wrapper (see also, author, license, copyright)

VERSION ^

Version 0.04

DESCRIPTION ^

instance of this class is capable of setting up POD credentials, as see also, author, license, copyright and returning it as string

SYNOPSIS ^

    use POD::Credentials;
    my $cred = POD::Credentials->new({
                                      author => 'Joe Doe', 
                                      license => <license text, default is Perl artistic>,
                                      copyright => <some text, default is copyright 
                                                    by author name with current year'>
                                    });
    print $cred->asString();

## it will automatically set SEE ALSO as the link to the name of the caller's package if defined and not main

METHODS ^

accessors/mutators are provided by Class::Accessor::Fast for each public field

new()

constructor, accepts single parameter - reference to hash where keys from the list: author copyright license year see_also

author()

accessor/mutator for the AUTHOR pod element

copyright()

accessor/mutator for the COPYRIGHT pod element

license()

accessor/mutator for the LICENSE pod element

year()

accessor/mutator for the year used in COPYRIGHT

see_also()

accessor/mutator for the SEE ALSO pod element

end_module()

if set then module will be finished with:

    __END__
  
    1;

and then credentials pod will be added

asString()

   returns string repsresentation, no arguments accepted

AUTHOR ^

Maxim Grigoriev, maxim_at_fnal_gov

BUGS ^

Please report any bugs or feature requests to bug-pod-credentials at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POD-Credentials. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc POD::Credentials

You can also look for information at:

COPYRIGHT & LICENSE ^

Copyright 2008-2009 Fermi Research Alliance (FRA).

This program is free software; you can redistribute it and/or modify it under the Fermitools license, see http://fermitools.fnal.gov/about/terms.html

syntax highlighting: