<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">NAME
    Sub::Spec::To::Pod - Generate POD documentation from sub spec

VERSION
    version 0.22

SYNOPSIS
     % perl -MSub::Spec::To::Pod=gen_module_subs_pod \
         -e'print gen_module_subs_pod(module=&gt;"MyModule")'

DESCRIPTION
    NOTICE: This module and the Sub::Spec standard is deprecated as of Jan
    2012. Rinci is the new specification to replace Sub::Spec, it is about
    95% compatible with Sub::Spec, but corrects a few issues and is more
    generic. Rias is the Perl implementation for Rinci and many of its
    modules can handle existing Sub::Spec sub specs. Rias::Sub::To::POD is
    the replacement for Sub::Spec::To::Pod.

    This module generates API POD documentation from sub specs in a
    specified module. Example specification:

     our %SPEC;

     $SPEC{sub1} = {
         summary     =&gt; 'Summary of sub1.',
         description =&gt; "Description of sub1 ...",
         args        =&gt; {
             arg1 =&gt; ['int*' =&gt; {
                 summary =&gt; 'Blah ...',
                 default =&gt; 0,
             }],
             arg2 =&gt; [str =&gt; {
                 summary =&gt; 'Blah blah ...',
                 ...
             }
         },
     }
     sub sub1 { ... }

     $SPEC{sub2} = { ... };
     sub sub2 { ... }

    Example output:

     =head2 sub1(%args) -&gt; [STATUS_CODE, ERR_MSG, RESULT]

     Summary of sub1.

     Description of sub1...

     Arguments (* denotes required arguments):

     =over 4

     =item * arg1* =&gt; INT (default 0)

     Blah ...

     =item * arg2 =&gt; STR (default none)

     Blah blah ...

     =back

     =head2 sub2(%args) -&gt; [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_module_subs_pod(%args) -&gt; RESULT
    Arguments ("*" denotes required arguments):

    *   load =&gt; *bool* (default 1)

        Whether to load module using "require".

    *   module* =&gt; *str*

    *   path =&gt; *str*

        Specify exact path to load module (instead of relying on @INC).

    *   specs =&gt; *hash*

  spec_to_pod(%args) -&gt; RESULT
    Generate POD documentation from sub spec.

    Arguments ("*" denotes required arguments):

    *   spec* =&gt; *hash*

SEE ALSO
    Sub::Spec

    Sub::Spec::To::HTML

    Sub::Spec::To::Org

    Sub::Spec::To::Text

AUTHOR
    Steven Haryanto &lt;stevenharyanto@gmail.com&gt;

COPYRIGHT AND LICENSE
    This software is copyright (c) 2012 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.

</pre></body></html>