NAME

Parse::Diagnostics - extract diagnostic messages from Perl source code

SYNOPSIS

    use Parse::Diagnostics 'parse_diagnostics';

VERSION

This documents version 0.03 of Parse::Diagnostics corresponding to git commit 120724d10ffaf6113f6f29df4a5178a0c5f71005 released on Fri Dec 9 14:52:59 2016 +0900.

DESCRIPTION

This module is a helper for writing documentation by extracting the diagnostic messages in Perl files.

FUNCTIONS

parse_diagnostics

    my $diagnostics = parse_diagnostics ($file);

Extract a list of diagnostic messages from $file. The return value is an array reference containing hash values.

type

The type of diagnostic, like "carp", "croak", etc.

message

The diagnostic message itself.

line

The line where the diagnostic begins.

DEPENDENCIES

Path::Tiny

Path::Tiny is used to read the input files.

C::Tokenize

C::Tokenize is used for making the regular expression for searching XS and C files for diagnostics.

AUTHOR

Ben Bullock, <bkb@cpan.org>

COPYRIGHT & LICENCE

This package and associated files are copyright (C) 2016 Ben Bullock.

You can use, copy, modify and redistribute this package and associated files under the Perl Artistic Licence or the GNU General Public Licence.