™.. Pod::Coverage - Online Linux Manual PageSection : 3
Updated : 2010-11-11
Source : perl v5.10.1
Note : User Contributed Perl Documentation
NAMEPod::Coverage − Checks if the documentation of a module is comprehensive
SYNOPSIS​ # in the beginnning... ​ perl −MPod::Coverage=Pod::Coverage −e666 ​ ​ # all in one invocation ​ use Pod::Coverage package => 'Fishy'; ​ ​ # straight OO ​ use Pod::Coverage; ​ my $pc = Pod::Coverage−>new(package => 'Pod::Coverage'); ​ print "We rock!" if $pc−>coverage == 1;
DESCRIPTIONDevelopers hate writing documentation. They'd hate it even more if their computer tattled on them, but maybe they'll be even more thankful in the long run. Even if not, perlmodstyle tells you to, so you must obey. This module provides a mechanism for determining if the pod for a given module is comprehensive. It expects to find either a \*(C`=head(n>1)\*(C'\fR or an \f(CW\*(C`=item\*(C'\fR block documenting a subroutine. Consider:
 # an imaginary Foo.pm
 package Foo; ​ =item foo ​ ​ The foo sub ​ ​ = cut ​ ​ sub foo {} ​ sub bar {} ​ ​ 1; ​ _ _END_ _ In this example \*(C`Foo::foo\*(C'\fR is covered, but \f(CW\*(C`Foo::bar\*(C'\fR is not, so the \f(CW\*(C`Foo\*(C'\fR package is only 50% (0.5) covered
MethodsPod::Coverage−>new(package => $package) Creates a new Pod::Coverage object. ​\*(C`package\*(C'\fR the name of the package to analyse ​\*(C`private\*(C'\fR an array of regexen which define what symbols are regarded as private (and so need not be documented) defaults to [ qr/^_/, qr/^import$/, qr/^DESTROY$/, qr/^AUTOLOAD$/, qr/^bootstrap$/,
        qr/^(TIE( SCALAR | ARRAY | HASH | HANDLE ) |
             FETCH | STORE | UNTIE | FETCHSIZE | STORESIZE |
             POP | PUSH | SHIFT | UNSHIFT | SPLICE | DELETE |
             EXISTS | EXTEND | CLEAR | FIRSTKEY | NEXTKEY | PRINT | PRINTF |
             WRITE | READLINE | GETC | READ | CLOSE | BINMODE | OPEN |
             EOF | FILENO | SEEK | TELL)$/x,
        qr/^( MODIFY | FETCH )_( REF | SCALAR | ARRAY | HASH | CODE |
                                 GLOB | FORMAT | IO)_ATTRIBUTES$/x,
        qr/^CLONE(_SKIP)?$/, ] This should cover all the usual magical methods for tie()d objects, attributes, generally all the methods that are typically not called by a user, but instead being used internally by perl. ​\*(C`also_private\*(C'\fR items are appended to the private list ​\*(C`trustme\*(C'\fR an array of regexen which define what symbols you just want us to assume are properly documented even if we can't find any docs for them If \*(C`pod_from\*(C'\fR is supplied, that file is parsed for the documentation, rather than using Pod::Find If \*(C`nonwhitespace\*(C'\fR is supplied, then only \s-1POD\s0 sections which have non-whitespace characters will count towards being documented. $object−>coverage Gives the coverage as a value in the range 0 to 1 $object−>why_unrated ​\*(C`$object\->coverage\*(C'\fR may return \f(CW\*(C`undef\*(C'\fR, to indicate that it was unable to deduce coverage for a package. If this happens you should be able to check \*(C`why_unrated\*(C'\fR to get a useful excuse. $object−>naked/$object−>uncovered Returns a list of uncovered routines, will implicitly call coverage if it's not already been called. Note, private and 'trustme' identifiers will be skipped. $object−>covered Returns a list of covered routines, will implicitly call coverage if it's not previously been called. As with \*(C`naked\*(C'\fR, private and 'trustme' identifiers will be skipped.
Debugging supportIn order to allow internals debugging, while allowing the optimiser to do its thang, \*(C`Pod::Coverage\*(C'\fR uses constant subs to define how it traces. Use them like so ​ sub Pod::Coverage::TRACE_ALL () { 1 } ​ use Pod::Coverage; Supported constants are: TRACE_ALL Trace everything. Well that's all there is so far, are you glad you came?
Inheritance interfaceThese abstract methods while functional in \*(C`Pod::Coverage\*(C'\fR may make your life easier if you want to extend \*(C`Pod::Coverage\*(C'\fR to fit your house style more closely. ​NOTE Please consider this interface as in a state of flux until this comment goes away. $object−>_CvGV($symbol) Return the GV for the coderef supplied. Used by \*(C`_get_syms\*(C'\fR to identify locally defined code. You probably won't need to override this one. $object−>_get_syms($package) return a list of symbols to check for from the specified packahe _get_pods Extract pod markers from the currently active package. Return an arrayref or undef on fail. _private_check($symbol) return true if the symbol should be considered private _trustme_check($symbol) return true if the symbol is a 'trustme' symbol
BUGSDue to the method used to identify documented subroutines ​\*(C`Pod::Coverage\*(C'\fR may completely miss your house style and declare your code undocumented. Patches and/or failing tests welcome.
TODOWiden the rules for identifying documentation Improve the code coverage of the test suite. Devel::Cover rocks so hard. 
SEE ALSOTest::More, Devel::Cover
AUTHORSRichard Clamp <richardc@unixbeard.net> Michael Stevens <mstevens@etla.org> some contributions from David Cantrell <david@cantrell.org.uk>
COPYRIGHTCopyright (c) 2001, 2003, 2004, 2006, 2007, 2009 Richard Clamp, Michael Stevens. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. 0
Johanes Gumabo
Data Size   :   21,830 byte
man-Pod::Coverage.3pmBuild   :   2024-12-29, 07:25   :  
Visitor Screen   :   x
Visitor Counter ( page / site )   :   3 / 256,707
Visitor ID   :     :  
Visitor IP   :   3.141.30.164   :  
Visitor Provider   :   AMAZON-02   :  
Provider Position ( lat x lon )   :   39.962500 x -83.006100   :   x
Provider Accuracy Radius ( km )   :   1000   :  
Provider City   :   Columbus   :  
Provider Province   :   Ohio ,   :   ,
Provider Country   :   United States   :  
Provider Continent   :   North America   :  
Visitor Recorder   :   Version   :  
Visitor Recorder   :   Library   :  
Online Linux Manual Page   :   Version   :   Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.29
Online Linux Manual Page   :   Library   :   lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page   :   Library   :   lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base   :   Version   :   Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base   :   Library   :   lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36
Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .
If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.
ERROR : Need New Coding :         (parse_manual_page_|252|Pod::Coverage.3pm|36/37|el══─{─══.|.el══─{─══. ds -- \|\(em\| )         (htmlprn|149|Pod::Coverage.3pm|36/37|.el══─{─══. ds --  —  |.el══─{─══. ds -- \|\(em\| )         (parse_manual_page_|252|Pod::Coverage.3pm|41|br══─}─══|'br══─}─══ )         (htmlprn|149|Pod::Coverage.3pm|41|'br══─}─══ |'br══─}─══ )         (rof_nr_x|149|Pod::Coverage.3pm|51/52|\nF|.ie \nF ══─{─══. de IX )         (rof_unit_scale_px|41|Pod::Coverage.3pm|51/52|F|.ie \nF ══─{─══. de IX )         (rof_if|19|Pod::Coverage.3pm|51/52|\nF|.ie \nF ══─{─══. de IX )         (htmlprn|149|Pod::Coverage.3pm|51/52|.ie \nF ══─{─══. de IX|.ie \nF ══─{─══. de IX )         (rof_escape_sequence|91|Pod::Coverage.3pm|53|\$1\t\\n%\t"\\$2" |. tm Index:\\$1\t\\n%\t"\\$2" )         (parse_manual_page_|252|Pod::Coverage.3pm|57|══─}─══|.══─}─══ )         (htmlprn|149|Pod::Coverage.3pm|57|.══─}─══ |.══─}─══ )         (rof_escape_sequence|91|Pod::Coverage.3pm|158|\*(C`=head(n>1)\*(C'\fR or an \f(CW\*(C`=item\*(C'\fR block documenting a |It expects to find either a \f(CW\*(C`=head(n>1)\*(C'\fR or an \f(CW\*(C`=item\*(C'\fR block documenting a )         (rof_escape_sequence|91|Pod::Coverage.3pm|179|\*(C`Foo::foo\*(C'\fR is covered, but \f(CW\*(C`Foo::bar\*(C'\fR is not, so the \f(CW\*(C`Foo\*(C'\fR |In this example \f(CW\*(C`Foo::foo\*(C'\fR is covered, but \f(CW\*(C`Foo::bar\*(C'\fR is not, so the \f(CW\*(C`Foo\*(C'\fR )         (rof_escape_sequence|91|Pod::Coverage.3pm|188|\*(C`package\*(C'\fR the name of the package to analyse |\&\f(CW\*(C`package\*(C'\fR the name of the package to analyse )         (rof_escape_sequence|91|Pod::Coverage.3pm|190|\*(C`private\*(C'\fR an array of regexen which define what symbols are regarded |\&\f(CW\*(C`private\*(C'\fR an array of regexen which define what symbols are regarded )         (rof_escape_sequence|91|Pod::Coverage.3pm|208|\*(C`also_private\*(C'\fR items are appended to the private list |\&\f(CW\*(C`also_private\*(C'\fR items are appended to the private list )         (rof_escape_sequence|91|Pod::Coverage.3pm|210|\*(C`trustme\*(C'\fR an array of regexen which define what symbols you just want |\&\f(CW\*(C`trustme\*(C'\fR an array of regexen which define what symbols you just want )         (rof_escape_sequence|91|Pod::Coverage.3pm|214|\*(C`pod_from\*(C'\fR is supplied, that file is parsed for the documentation, |If \f(CW\*(C`pod_from\*(C'\fR is supplied, that file is parsed for the documentation, )         (rof_escape_sequence|91|Pod::Coverage.3pm|217|\*(C`nonwhitespace\*(C'\fR is supplied, then only \s-1POD\s0 sections which have |If \f(CW\*(C`nonwhitespace\*(C'\fR is supplied, then only \s-1POD\s0 sections which have )         (rof_escape_sequence|91|Pod::Coverage.3pm|226|\*(C`$object\->coverage\*(C'\fR may return \f(CW\*(C`undef\*(C'\fR, to indicate that it was |\&\f(CW\*(C`$object\->coverage\*(C'\fR may return \f(CW\*(C`undef\*(C'\fR, to indicate that it was )         (rof_escape_sequence|91|Pod::Coverage.3pm|228|\*(C`why_unrated\*(C'\fR to get a useful excuse. |be able to check \f(CW\*(C`why_unrated\*(C'\fR to get a useful excuse. )         (rof_escape_sequence|91|Pod::Coverage.3pm|242|\*(C`naked\*(C'\fR, private and 'trustme' identifiers will be skipped. |As with \f(CW\*(C`naked\*(C'\fR, private and 'trustme' identifiers will be skipped. )         (rof_escape_sequence|91|Pod::Coverage.3pm|246|\*(C`Pod::Coverage\*(C'\fR uses constant subs to define how it traces. |do its thang, \f(CW\*(C`Pod::Coverage\*(C'\fR uses constant subs to define how it traces. )         (rof_escape_sequence|91|Pod::Coverage.3pm|263|\*(C`Pod::Coverage\*(C'\fR may make |These abstract methods while functional in \f(CW\*(C`Pod::Coverage\*(C'\fR may make )         (rof_escape_sequence|91|Pod::Coverage.3pm|264|\*(C`Pod::Coverage\*(C'\fR to fit your |your life easier if you want to extend \f(CW\*(C`Pod::Coverage\*(C'\fR to fit your )         (rof_escape_sequence|91|Pod::Coverage.3pm|272|\*(C`_get_syms\*(C'\fR to identify |Return the \s-1GV\s0 for the coderef supplied. Used by \f(CW\*(C`_get_syms\*(C'\fR to identify )         (rof_escape_sequence|91|Pod::Coverage.3pm|294|\*(C`Pod::Coverage\*(C'\fR may completely miss your house style and declare your |\&\f(CW\*(C`Pod::Coverage\*(C'\fR may completely miss your house style and declare your )