Module::Install::DBICx::AutoDoc - Use your Makefile to run DBICx::AutoDoc
Version 0.03
In MakeFile.PL:
dbicx_autodoc('doc'); # use name() or module_name() as Schema package
# or
dbicx_autodoc('doc','My::Schema'); # better be in lib/
# or
dbicx_autodoc({
output => 'doc',
schema => 'My::Schema'
});
From CLI:
make autodoc
Add a DBICx::AutoDoc call to a Makefile
Example (in Makefile.PL):
name 'My-Schema';
all_from 'lib/My/Schema.pm';
author 'Foo Bar';
dbicx_autodoc('doc'); # use name() or module_name() as Schema package
# or
dbix_autodoc('doc','My::Schema'); # better be in lib/
# or
dbix_autodoc({
output => 'doc',
schema => 'My::Schema'
});
This would run DBICx::AutoDoc for My::Schema and store documents in <module-directory>/doc.
Generates our our Makefile statements
Generates or DBICx::AutoDoc command line call
Jason M. Mills, <jmmills at cpan.org>
Warning!, I have yet to write a "proper" unit test for the Makefile preamble output. I do use this module for my internal db libs and haven't found a problem yet. If someone wanted to contribute a good unit test it would be greatly appreciated.
Please report any bugs or feature requests to bug-module-install-dbicx-autodoc at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module-Install-DBICx-AutoDoc. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
You can find documentation for this module with the perldoc command.
perldoc Module::Install::DBICx::AutoDoc
You can also look for information at:
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module-Install-DBICx-AutoDoc
Module::Install, Module::Install::AutoManifest
Copyright 2008 Jason M. Mills
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
