From 273574ca93d3fef595945dbead21586f56f3bb13 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Quelin?= Date: Tue, 20 Jan 2009 14:01:35 +0100 Subject: [PATCH] pod update --- lib/App/CPAN2Pkg.pm | 87 ++++++++++++++++++++++++++--------------------------- 1 file changed, 42 insertions(+), 45 deletions(-) diff --git a/lib/App/CPAN2Pkg.pm b/lib/App/CPAN2Pkg.pm index d411fdd..9a0cc85 100644 --- a/lib/App/CPAN2Pkg.pm +++ b/lib/App/CPAN2Pkg.pm @@ -59,76 +59,71 @@ __END__ =head1 NAME -App::CPAN2Pkg - The great new App::CPAN2Pkg! +App::CPAN2Pkg - generating native linux packages from cpan -=head1 VERSION -Version 0.01 -=cut +=head1 SYNOPSIS -our $VERSION = '0.01'; + $ cpan2pkg + $ cpan2pkg Module::Foo Module::Bar ... -=head1 SYNOPSIS -Quick summary of what the module does. +=head1 DESCRIPTION -Perhaps a little code snippet. +Don't use this module directly, refer to the C script instead. - use App::CPAN2Pkg; +C is the controller for the C application. It +implements a POE session, responsible to schedule and advance module +packagement. - my $foo = App::CPAN2Pkg->new(); - ... +It is spawned by the poe session responsible for the user interface. -=head1 EXPORT -A list of functions that can be exported. You can delete this section -if you don't export anything, such as for a purely object-oriented module. -=head1 FUNCTIONS +=head1 PUBLIC PACKAGE METHODS -=head2 function1 +=head2 my $id = App::CPAN2Pkg->spawn( \%params ) -=cut +This method will create a POE session responsible for coordinating the +package(s) creation. -sub function1 { -} +It will return the POE id of the session newly created. -=head2 function2 +You can tune the session by passing some arguments as a hash +reference, where the hash keys are: -=cut +=over 4 -sub function2 { -} +=item * modules => \@list_of_modules -=head1 AUTHOR +A list of modules to start packaging. -Jerome Quelin, C<< >> - -=head1 BUGS -Please report any bugs or feature requests to C, or through -the web interface at L. I will be notified, and then you'll -automatically be notified of progress on your bug as I make changes. +=back +=head1 BUGS -=head1 SUPPORT +Please report any bugs or feature requests to C, or through the web interface at +L. I will +be notified, and then you'll automatically be notified of progress on +your bug as I make changes. -You can find documentation for this module with the perldoc command. - perldoc App::CPAN2Pkg +=head1 SEE ALSO -You can also look for information at: +Our git repository is located at L, +and can be browsed at L. -=over 4 -=item * RT: CPAN's request tracker +You can also look for information on this module at: -L +=over 4 =item * AnnoCPAN: Annotated CPAN documentation @@ -138,24 +133,26 @@ L L -=item * Search CPAN +=item * Open bugs -L +L =back -=head1 ACKNOWLEDGEMENTS +=head1 AUTHOR + +Jerome Quelin, C<< >> -=head1 COPYRIGHT & LICENSE -Copyright 2009 Jerome Quelin, all rights reserved. -This program is free software; you can redistribute it and/or modify it -under the same terms as Perl itself. +=head1 COPYRIGHT & LICENSE + +Copyright (c) 2009 Jerome Quelin, all rights reserved. +This program is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. =cut -1; # End of App::CPAN2Pkg -- 2.11.4.GIT