r53670 - in /trunk/dh-make-perl: lib/DhMakePerl.pm t/pod-coverage.t

[dmn at users.alioth.debian.org]

Author: dmn
Date: Sat Mar  6 12:40:24 2010
New Revision: 53670

URL: http://svn.debian.org/wsvn/pkg-perl/?sc=1&rev=53670
Log:
document DhMakePerl

Modified:
    trunk/dh-make-perl/lib/DhMakePerl.pm
    trunk/dh-make-perl/t/pod-coverage.t

Modified: trunk/dh-make-perl/lib/DhMakePerl.pm
URL: http://svn.debian.org/wsvn/pkg-perl/trunk/dh-make-perl/lib/DhMakePerl.pm?rev=53670&op=diff
==============================================================================
--- trunk/dh-make-perl/lib/DhMakePerl.pm (original)
+++ trunk/dh-make-perl/lib/DhMakePerl.pm Sat Mar  6 12:40:24 2010
@@ -32,14 +32,11 @@
 
 =head1 SYNOPSIS
 
-TO BE FILLED
-
     use DhMakePerl;
 
-    my $foo = DhMakePerl->new();
-    ...
+    DhMakePerl->run;
 
-=head1 METHODS
+=head1 CLASS METHODS
 
 =over
 
@@ -49,6 +46,19 @@
 use DhMakePerl::Config;
 use Module::CoreList ();
 use version          ();
+
+=item run( I<%init> )
+
+Runs DhMakePerl.
+
+Unless the %init contains an I<cfg> member, constructs and instance of
+L<DhMakePerl::Config> and assigns it to I<$init{cfg}>.
+
+Then determines the dh-make-perl command requested (via cfg->command), loads
+the appropriate I<DhMakePerl::Command::$command> class, constructs an instance
+of it and calls its I<execute> method.
+
+=cut
 
 sub run {
     my ( $class, %c ) = @_;
@@ -72,6 +82,15 @@
     return $self->execute;
 }
 
+=item is_core_module I<module>, I<version>
+
+Returns the version of the C<perl> package containing the given I<module> (at
+least version I<version>).
+
+Returns C<undef> if I<module> is not a core module.
+
+=cut
+
 sub is_core_module {
     my ( $self, $module, $ver ) = @_;
 
@@ -84,6 +103,12 @@
 
     return $v;
 }
+
+=item get_apt_contents
+
+Returns (possibly cached) instance of L<Debian::AptContents>.
+
+=cut
 
 sub get_apt_contents {
     my $self = shift;

Modified: trunk/dh-make-perl/t/pod-coverage.t
URL: http://svn.debian.org/wsvn/pkg-perl/trunk/dh-make-perl/t/pod-coverage.t?rev=53670&op=diff
==============================================================================
--- trunk/dh-make-perl/t/pod-coverage.t (original)
+++ trunk/dh-make-perl/t/pod-coverage.t Sat Mar  6 12:40:24 2010
@@ -21,7 +21,6 @@
 
 for (@modules) {
 SKIP: {
-        skip "DhModPerl is not entirely documented", 1, if $_ eq 'DhMakePerl';
         skip "Command::Packaging needs documenting", 1, if $_ eq 'DhMakePerl::Command::Packaging';
         skip "Command::make needs documenting", 1, if $_ eq 'DhMakePerl::Command::make';
         pod_coverage_ok( $_,