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

Perl::Critic::Utils::POD::ParseInteriorSequence - Pod::Parser subclass to find all interior sequences.

Author

       Thomas R. Wyant, III wyantatcpandotorg

Description

       Provides a means to extract interior sequences from POD text.

Interface Support

       This module is considered to be private to Perl::Critic. It can be changed or removed without notice.

Methods

       "get_interior_sequences( $pod_text )"
           Returns  an  array  of  all  the  interior  sequences  from a given chunk of POD text, represented as
           Pod::InteriorSequence objects.  The POD text is assumed to begin with a POD command (e.g.  "=pod").

       "interior_sequence( $seq_cmd, $seq_arg, $pod_seq )"
           Overrides the parent's  method  of  the  same  name.  Stashes  the  $pod_seq  argument,  which  is  a
           "Pod::InteriorSequence" object, so that "get_interior_sequences()" has access to it.

Name

       Perl::Critic::Utils::POD::ParseInteriorSequence - Pod::Parser subclass to find all interior sequences.

Synopsis

           use Perl::Critic::Utils::POD::ParseInteriorSequence;

           my $parser = Perl::Critic::Utils::POD::ParseInteriorSequence->new();
           my @sequences = $parser->parse_interior_sequences(
               $pod->content() );

See Also