git.maemo.org Git - dh-make-perl/blob - dev/i386/libpod-coverage-perl/libpod-coverage-perl-0.19/README

   1 README for Pod::Coverage 0.19
   2
   3 =head1 NAME
   4
   5 Pod::Coverage - Checks if the documentation of a module is comprehensive
   6
   7 =head1 SYNOPSIS
   8
   9   # in the beginnning...
  10   perl -MPod::Coverage=Pod::Coverage -e666
  11
  12   # all in one invocation
  13   use Pod::Coverage package => 'Fishy';
  14
  15   # straight OO
  16   use Pod::Coverage;
  17   my $pc = Pod::Coverage->new(package => 'Pod::Coverage');
  18   print "We rock!" if $pc->coverage == 1;
  19
  20
  21
  22 =head1 DEPENDENCIES
  23
  24 This module has external dependencies on the following modules:
  25
  26  Devel::Symdump 2.01
  27  Pod::Find      0.21
  28  Pod::Parser    1.13
  29
  30 =head1 INSTALLATION
  31
  32  perl Build.PL
  33  perl Build test
  34
  35 and if all goes well
  36
  37  perl Build install
  38
  39 =head1 HISTORY
  40
  41 What changed over the last 3 revisions
  42
  43 =over
  44
  45 =item 0.19      Thursday 13th September, 2007
  46
  47         Don't use _CvGV to determine if a sub was imported, there's a handy
  48         flag - GVf_IMPORTED_CV.  Fixes 5.9.5 and future perls
  49         (solution by Nicholas Clark)
  50
  51
  52
  53 =item 0.18    Friday 4th August, 2006
  54
  55         Rewrite _CvGV in terms of B::CV - no xs dependency anymore
  56         (suggested by Tim Bunce)
  57
  58         Add the (FETCH|MODIFY)_$foo_ATTRIBUTES methods to the private
  59         stoplists. (rt #12451)
  60
  61         Support documentation where the method name is documented in a
  62         ::qualified style (rt #14635)
  63
  64         Ignores new (5.8) magic CLONE and CLONE_SKIP methods. (rt #17489)
  65
  66         Added a nonwhitespace option (Alex - rt #14950)
  67
  68
  69
  70 =item 0.17      Tuesday 23rd November, 2004
  71
  72         Fixed a further case reported by Jos Boumans where
  73         =head2 $self->foo(); was intepreted as documentation for a
  74         C<foo()> method.  (more XS4ALL house style)
  75
  76 =back
  77
  78 =head1 SEE ALSO
  79
  80 L<Test::More>, L<Devel::Cover>
  81
  82 =head1 AUTHORS
  83
  84 Richard Clamp <richardc@unixbeard.net>
  85
  86 Michael Stevens <mstevens@etla.org>
  87
  88 some contributions from David Cantrell <david@cantrell.org.uk>
  89
  90 =head1 COPYRIGHT
  91
  92 Copyright (c) 2001, 2003, 2004, 2006, 2007 Richard Clamp, Michael
  93 Stevens. All rights reserved.  This program is free software; you can
  94 redistribute it and/or modify it under the same terms as Perl itself.
  95