[Mastering-perl] Working with Pod

[Florian Merges]

Hi,

Chapter: Working with Pod
====================

Section: The Pod format
-----------------------------------

Perl continues to parse the pod until it reaches the =cut directive.

====> I don't know if it's worth to add: or the EOF.


Section: Translating Pod
------------------------------------

    SubSection: Pod translators
    -----------------------------------------

    You've probably used on without even knowing it;   ====> one


    SubSection: Pod::Perldoc::ToToc
    ------------------------------------------------

    I set the output destination with $parser-output_fh()>.    ====>
$parser->output_fh()

   Once I have that setup, I call $parser-parse_file()>;       ====>
$parser->parse_file()


   SubSection: Pod::Simple
   -------------------------------------

   Because of the indentation, the local scope to make the variables not
available from outside of the method
   is not so easy to realize.


   SubSection: Apache::Pod
   --------------------------------------

   Better than this, I think is the Hack #3 of the Perl Hacks, the use of
the module Pod::Webserver. Could be said...


Section: Testing Pod
------------------------------

    SubSection: Checking Pod
    ---------------------------------------

    Here a suitable example of pod.t:

use strict;
use warnings;
use Test::More;

eval "use Test::Pod 1.14";
plan skip_all => 'Test::Pod 1.14 required' if $@;
plan skip_all => 'set TEST_POD to enable this test' unless $ENV{TEST_POD};

all_pod_files_ok();


    SubSection: Pod Coverage
    ---------------------------------------

    I lift the this snippet right out of the documentation.      ====> I
lift this snippet



Regards,

Florian
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://five.pairlist.net/pipermail/mastering-perl/attachments/20061222/2805b90b/attachment.html