GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  POD::COVERAGE::TRUSTPOD (3)

.ds Aq ’

NAME

Pod::Coverage::TrustPod - allow a module’s pod to contain Pod::Coverage hints

CONTENTS

VERSION

version 0.100003

DESCRIPTION

This is a Pod::Coverage subclass (actually, a subclass of Pod::Coverage::CountParents) that allows the POD itself to declare certain symbol names trusted.

Here is a sample Perl module:



  package Foo::Bar;

  =head1 NAME

  Foo::Bar - a bar at which fooes like to drink

  =head1 METHODS

  =head2 fee

  returns the bar tab

  =cut

  sub fee { ... }

  =head2 fie

  scoffs at bar tab

  =cut

  sub fie { ... }

  sub foo { ... }

  =begin Pod::Coverage

    foo

  =end Pod::Coverage

  =cut



This file would report full coverage, because any non-empty lines inside a block of POD targeted to Pod::Coverage are treated as trustme patterns. Leading and trailing whitespace is stripped and the remainder is treated as a regular expression anchored at both ends.

Remember, anywhere you could use =begin and =end as above, you could instead write:



  =for Pod::Coverage foo



In some cases, you may wish to make the entire file trusted. The special pattern *EVERYTHING* may be provided to do just this.

Keep in mind that Pod::Coverage::TrustPod sets up exceptions using the trust mechanism rather than the privacy mechanism in Pod::Coverage. This is unlikely ever to matter to you, but it’s true.

AUTHOR

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 POD::COVERAGE::TRUSTPOD (3) 2013-11-05

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.