/ 
POD-Credentials-0.01
River stage one • 1 direct dependent • 1 total dependent
/ POD::Credentials

NAME

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

VERSION

Version 0.01

DESCRIPTION

instance of this class is capable of setting up POD credentials, as 
 C<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 B<SEE ALSO> as the link to the name of the caller's package if defined and not C<main>

METHODS

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

new()

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

author()

accessor/mutator  for the C<AUTHOR> pod element

copyright()

accessor/mutator  for the C<COPYRIGHT> pod element

license(),

 accessor/mutator  for the C<LICENSE> pod element

year(),

   accessor/mutator  for the year used in C<COPYRIGHT>

see_also()

  accessor/mutator  for the C<SEE ALSO> pod element

end_module()

if set then module will be finished with:
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:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2008 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