my $p = YAPE::Regex::Explain->new($regex);
Calls YAPE::Regexs new method (see its docs).
my $p = YAPE::Regex::Explain->explain($mode);
Returns a string explaining the regex. While not required for all regexes, it is sometimes necessary to compile the regex using the qr// operator before passing it to the explain method. If $mode is regex, it will output a valid regex (instead of the normal string). If $mode is silent, no comments will be added, but the regex will be expanded into a readable format.
Print the full explanation for the regex \Q[abc]\E\d+, compiling it first:
Print the explanation for the regex \w[a-f]*, without comments:
Print the explanation for a multi-line regex:
There is no support for regular expression syntax added after Perl version 5.6, particularly any constructs added in 5.10. For examples, refer to:
The original author is Jeff japhy Pinyan (CPAN ID: PINYAN).
Gene Sullivan (firstname.lastname@example.org) is a co-maintainer.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.
|perl v5.20.3||EXPLAIN (3)||2010-09-14|