logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Pod::Index::Extract - Extracts a "pod scope"

Author

       Ivan Tubert-Brohman <itub@cpan.org>

Description

       This module is a subclass of Pod::Parser. It outputs POD without any transformation; however, it only
       outputs the POD that is "in scope" as defined in Pod::Index.

       To use this module, you first need to position a filehandle at the beginning of the desired scope, and
       then call "parse_from_filehandle" with that filehandle for input. It will just print the POD until it
       reaches the end of the scope, after which it will jump to the end of the file.

       If the scope starts with an "=item", it will wrap it with an "=over" and a "=back", so it can be used as
       valid POD in isolation.

Name

       Pod::Index::Extract - Extracts a "pod scope"

See Also

       Pod::Index, Pod::Index::Entry, Pod::Parser

Synopsis

           use Pod::Index::Extract;

           my $parser = Pod::Index::Extract->new;
           # [...] get $fh_in to the desired position
           $parser->parse_from_filehandle($fh_in, $fh_out);

Version

       0.14

See Also