r28049 - /trunk/dh-make-perl/lib/Debian/AptContents.pm

[dmn at users.alioth.debian.org]

Author: dmn
Date: Thu Dec 11 08:09:29 2008
New Revision: 28049

URL: http://svn.debian.org/wsvn/pkg-perl/?sc=1&rev=28049
Log:
a bit of POD plus a proper copyright and license

Modified:
    trunk/dh-make-perl/lib/Debian/AptContents.pm

Modified: trunk/dh-make-perl/lib/Debian/AptContents.pm
URL: http://svn.debian.org/wsvn/pkg-perl/trunk/dh-make-perl/lib/Debian/AptContents.pm?rev=28049&op=diff
==============================================================================
--- trunk/dh-make-perl/lib/Debian/AptContents.pm (original)
+++ trunk/dh-make-perl/lib/Debian/AptContents.pm Thu Dec 11 08:09:29 2008
@@ -1,4 +1,23 @@
 package Debian::AptContents;
+
+=head1 NAME
+
+Debian::AptContents - parse/search through apt-file's Contents files
+
+=head1 SYNOPSIS
+
+    my $c = Debian::AptContents->new( { homedir => '~/.dh-make-perl' } );
+    my @pkgs = $c->find_file_packages('/usr/bin/foo');
+    my @pkgs = $c->find_perl_module_packages('Foo::Bar');
+
+=head1 TODO
+
+This needs to really work not only for Perl modules.
+
+A module specific to Perl modules is needed by dh-make-perl, but it can
+subclass Debian::AptContents, which needs to become more generic.
+
+=cut
 
 use base qw(Class::Accessor);
 __PACKAGE__->mk_accessors(
@@ -276,3 +295,33 @@
 }
 
 1;
+
+=head1 AUTHOR
+
+=over 4
+
+=item Damyan Ivanov <dmn at debian.org>
+
+=back
+
+=head1 COPYRIGHT & LICENSE
+
+=over 4
+
+=item Copyright (C) 2008 Damyan Ivanov <dmn at debian.org>
+
+=back
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License version 2 as published by the Free
+Software Foundation.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
+Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+=cut