Dist::Zilla::Plugin::Documentation::SQL - Create a file gathering all =sql commands
version 0.03
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
This method returns your main_module documentation linked dir, to put generated documentation in it.
$documentation_dir = $self->documentation_dir;
Retrieve the location where to put the file, and give the filename.
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.
Armand Leclercq <armand.leclercq@gmail.com>
This software is Copyright (c) 2014 by Armand Leclercq.
This is free software, licensed under:
The GNU General Public License, Version 3, June 2007
To install Dist::Zilla::Plugin::Documentation::SQL, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dist::Zilla::Plugin::Documentation::SQL
CPAN shell
perl -MCPAN -e shell install Dist::Zilla::Plugin::Documentation::SQL
For more information on module installation, please visit the detailed CPAN module installation guide.