/ 
Dist-Zilla-Plugin-Documentation-SQL-0.02
River stage zero No dependents
/ Dist::Zilla::Plugin::Documentation::SQL

NAME

Dist::Zilla::Plugin::Documentation::SQL - Create a file gathering all =sql commands

VERSION

version 0.02

SYNOPSIS

Put in your dist.ini file

name = Sample-Package
author = E. Xavier Ample <example@example.org>
license = GPL_3
copyright_holder = E. Xavier Ample
copyright_year = 2014
version = 0.42

[Documentation::SQL]

Then, dist will automatically search all your package files for documentation that looks like

=sql SELECT * FROM table

=cut

And will put all of them in a single file, located at (for the example)

lib/Sample/Package/Documentation/SQL.pod

METHODS

documentation_dir

This method returns your main_module documentation linked dir, to put generated documentation in it.

$documentation_dir = $self->documentation_dir;

documentation_file

Retrieve the location where to put the file, and give the filename.

munge_files

A Dist::Zilla::Role::FileMunger overwriting in order to have direct access to every content that are included in a =sql command.

This method is called directly by dist.

AUTHOR

Armand Leclercq <armand.leclercq@gmail.com>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2014 by Armand Leclercq.

This is free software, licensed under:

The GNU General Public License, Version 3, June 2007