Guillaume Aubert > App-GitHooks-Plugin-ValidatePODFormat-v1.0.1 > App::GitHooks::Plugin::ValidatePODFormat

Download:
App-GitHooks-Plugin-ValidatePODFormat-v1.0.1.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: v1.0.1   Source  

NAME ^

App::GitHooks::Plugin::ValidatePODFormat - Validate POD format in Perl and POD files.

DESCRIPTION ^

VERSION ^

Version 1.0.1

METHODS ^

get_file_pattern()

Return a pattern to filter the files this plugin should analyze.

        my $file_pattern = App::GitHooks::Plugin::ValidatePODFormat->get_file_pattern(
                app => $app,
        );

get_file_check_description()

Return a description of the check performed on files by the plugin and that will be displayed to the user, if applicable, along with an indication of the success or failure of the plugin.

        my $description = App::GitHooks::Plugin::ValidatePODFormat->get_file_check_description();

run_pre_commit_file()

Code to execute for each file as part of the pre-commit hook.

  my $success = App::GitHooks::Plugin::ValidatePODFormat->run_pre_commit_file();

BUGS ^

Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/App-GitHooks-Plugin-ValidatePODFormat/issues/new. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

        perldoc App::GitHooks::ValidatePODFormat

You can also look for information at:

AUTHOR ^

Guillaume Aubert, <aubertg at cpan.org>.

COPYRIGHT & LICENSE ^

Copyright 2013-2014 Guillaume Aubert.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/

syntax highlighting: