/ 
ExtUtils-ModuleMaker-Siffra-0.06
River stage zero No dependents
/ ExtUtils::ModuleMaker::Siffra

block_new_method()

Usage     : $self->block_new_method() within text_pm_file()
Purpose   : Build 'new()' method as part of a pm file
Returns   : String holding sub new.
Argument  : $module: pointer to the module being built
            (as there can be more than one module built by EU::MM);
            for the primary module it is a pointer to $self
Throws    : n/a
Comment   : This method is a likely candidate for alteration in a subclass,
            e.g., pass a single hash-ref to new() instead of a list of
            parameters.

new()

Usage     : $self->block_new_method() within text_pm_file()
Purpose   : Build 'new()' method as part of a pm file
Returns   : String holding sub new.
Argument  : $module: pointer to the module being built
            (as there can be more than one module built by EU::MM);
            for the primary module it is a pointer to $self
Throws    : n/a
Comment   : This method is a likely candidate for alteration in a subclass,
            e.g., pass a single hash-ref to new() instead of a list of
            parameters.

block_begin()

Usage     : $self->block_begin($module) within text_pm_file()
Purpose   : Composes the standard code for top of a Perl pm file
Returns   : String holding code for top of pm file
Argument  : $module: pointer to the module being built
            (as there can be more than one module built by EU::MM);
            for the primary module it is a pointer to $self
Throws    : n/a
Comment   : This method is a likely candidate for alteration in a subclass,
            e.g., you don't need Exporter-related code if you're building
            an OO-module.
Comment   : References $self keys NAME and (indirectly) VERSION

default_values()

Usage     : $self->default_values() within complete_build()
Purpose   : Build Makefile
Returns   : Hash holding default_values
Argument  : n/a
Throws    : n/a
Comment   : This method is a likely candidate for alteration in a subclass

text_Makefile()

Usage     : $self->text_Makefile() within complete_build()
Purpose   : Build Makefile
Returns   : String holding text of Makefile
Argument  : n/a
Throws    : n/a
Comment   : This method is a likely candidate for alteration in a subclass

pod_wrapper()

Usage     : $self->pod_wrapper($string) within block_pod()
Purpose   : When writing POD sections, you have to 'escape'
            the POD markers to prevent the compiler from treating
            them as real POD.  This method 'unescapes' them and puts header
            and closer around main POD block in pm file, along with warning
            about stub documentation.
Argument  : String holding text of POD which has been built up
            within block_pod().
Comment   : $head and $tail inside pod_wrapper() are optional and, in a
            subclass, could be redefined as empty strings;
            but $cutline is mandatory as it supplies the last =cut

text_perlcritic_test()

Usage     : $self->text_perlcritic_test() within complete_build()
Purpose   : Composes text for t/pod-coverage.t
Returns   : String with text of t/pod-coverage.t
Argument  : n/a
Throws    : n/a
Comment   : Adapted from Andy Lester's Module::Starter
Comment   : I don't think of much of this metric, but Andy and Damian do,
            so if you want it you set INCLUDE_POD_COVERAGE_TEST => 1

complete_build()

Usage     : $self->pod_wrapper($string) within block_pod()
Purpose   : When writing POD sections, you have to 'escape'
            the POD markers to prevent the compiler from treating
            them as real POD.  This method 'unescapes' them and puts header
            and closer around main POD block in pm file, along with warning
            about stub documentation.
Argument  : String holding text of POD which has been built up
            within block_pod().
Comment   : $head and $tail inside pod_wrapper() are optional and, in a
            subclass, could be redefined as empty strings;
            but $cutline is mandatory as it supplies the last =cut

NAME

ExtUtils::ModuleMaker::Siffra - Create a module

SYNOPSIS

use ExtUtils::ModuleMaker::Siffra;
blah blah blah

DESCRIPTION

Stub documentation for this module was created by ExtUtils::ModuleMaker. It looks like the author of the extension was negligent enough to leave the stub unedited.

Blah blah blah.

USAGE

BUGS

SUPPORT

AUTHOR

Luiz Benevenuto
CPAN ID: LUIZBENE
Siffra TI
luiz@siffra.com.br
https://siffra.com.br

COPYRIGHT

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

SEE ALSO

perl(1).