NAME Sub::Spec::Pod - Generate POD documentation for subs VERSION version 0.14 SYNOPSIS % perl -MSub::Spec::Pod=gen_pod -e'print gen_pod(module=>"MyModule")' DESCRIPTION This module generates API POD documentation for all subs in specified module. Example output: =head2 sub1(%args) -> [STATUS_CODE, ERR_MSG, RESULT] Summary of sub1. Description of sub1... Arguments (* denotes required arguments): =over 4 =item * arg1* => INT (default 0) Blah ... =item * arg2 => STR (default none) Blah blah ... =back =head2 sub2(%args) -> [STATUS_CODE, ERR_MSG, RESULT] ... This module uses Log::Any logging framework. FUNCTIONS None of the functions are exported by default, but they are exportable. gen_pod(%args) -> POD Generate POD documentation. Arguments (* denotes required argument): * module* => STR Module name to use. The module will be required if not already so. * path => STR (optional, default none) Instruct the function to require the specified path instead of guessing from module name. Useful when you want to from a specific location (e.g. when building) and do not want to modify @INC. * specs => HASHREF (optional, default none) Instead of trying to require the module to get the spec, use the supplied specs. * load => BOOL (optional, default 1) If set to 0, will not attempt to require the module. SEE ALSO Sub::Spec AUTHOR Steven Haryanto COPYRIGHT AND LICENSE This software is copyright (c) 2011 by Steven Haryanto. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.