—

              
__END__
HideShow 289 lines of Pod
=head1 NAME
Module::Generate - Assisting with module generation.
=head1 VERSION
Version 0.01
=cut
=head1 SYNOPSIS
        use Module::Generate;
        Module::Generate->dist('Planes')
                ->author('LNATION')
                ->email('email@lnation.org')
                ->version('0.01')
                ->class('Planes')
                        ->abstract('Over my head.')
                        ->our('$type')
                        ->begin(sub {
                                $one = 'boeing';
                        })
                        ->sub('new')
                                ->code(sub { return bless {}, $_[0] })
                                ->example('my $plane = Planes->new')
                        ->sub('type')
                                ->code(sub { $type })
                                ->pod('Returns the type of plane.')
                                ->example('$plane->type')
                        ->sub('altitude')
                                ->code(sub {
                                        $_[1] / $_[2];
                                        ...
                                })
                                ->pod('Discover the altitude of the plane.')
                                ->example('$plane->altitude(100, 100)')
                ->generate;
=head1 SUBROUTINES/METHODS
=head2 dist
Provide a name for the distribution.
        my $dist = Module::Generate->dist('Planes');
=cut
=head2 lib
Provide a path where the generated files will be compiled.
        my $module = Module::Generate->lib('./path/to/lib');
=cut
=head2 author
The author of the distribution/module.
        my $module = Module::Generate->author('LNATION');
=cut
=head2 email
The authors email of the distribution/module.
        my $module = Module::Generate->email('email@lnation.org');
=cut
=head2 version
The version number of the distribution/module.
        my $version = Module::Generate->version('0.01');
=cut
=head2 class
Start a new class/package/module..
         
        my $class = Module::Generate->class('Planes');
=cut
=head2 abstract
Provide abstract text for the class.
        $class->abstract('Over my head.');
=head2 synopsis
Provide a synopsis for the class.
        $class->synopsis('...');
=cut
=head2 use
Declare modules that should be included in the class.
        $class->use(qw/Moo MooX::LazierAttributes/);
=cut
=head2 base
Establish an ISA relationship with base classes at compile time. 
Unless you are using the fields pragma, consider this discouraged in favor of the lighter-weight parent.
        $class->base(qw/Foo Bar/);
=cut
=head2 paarent
Establish an ISA relationship with base classes at compile time. 
        $class->parent(qw/Foo Bar/);
=cut
=head2 require
Require library files to be included if they have not already been included.
        $class->require(qw/Foo Bar/);
=cut
=head2 our
Declare variable of the same name in the current package for use within the lexical scope.
        $class->our(qw/$one $two/);
=cut
=head2 begin
Define a code block is executed as soon as possible.
        $class->begin(sub {
                ...
        });
=cut
=head2 unitcheck
Define a code block that is executed just after the unit which defined them has been compiled.
        $class->unitcheck(sub {
                ...
        });
=cut
=head2 check
Define a code block that is executed just after the initial Perl compile phase ends and before the run time begins.
        $class->check(sub {
                ...
        });
=cut
=head2 init
Define a code block that is executed just before the Perl runtime begins execution.
        $class->init(sub {
                ...
        });
=cut
=head2 end
Define a code block is executed as late as possible.
        $class->end(sub {
                ...
        });
=cut
=head2 sub
Define a sub routine/method.
         
        my $sub = $class->sub('name');
=cut
=head2 code
Define the code that will be run for the sub.
        $sub->code(sub {
                return 'Robert';
        });
=cut
=head2 pod
Provide pod text that describes the sub.
        $sub->pod('What is my name?');
=cut
=head2 example
Provide a code example which will be suffixed to the pod definition.
        $sub->example('$foo->name');
=cut
=head2 build
Compile the code.
         
        $sub->build(%args);
=cut
=head1 AUTHOR
LNATION, C<< <email at lnation.org> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-module-generate at rt.cpan.org>, or through
the web interface at L<https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module-Generate>.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
    perldoc Module::Generate
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker (report bugs here)
L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=Module-Generate>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Module-Generate>
=item * CPAN Ratings
L<https://cpanratings.perl.org/d/Module-Generate>
=item * Search CPAN
L<https://metacpan.org/release/Module-Generate>
=back
=head1 ACKNOWLEDGEMENTS
=head1 LICENSE AND COPYRIGHT
This software is Copyright (c) 2020 by LNATION.
This is free software, licensed under:
  The Artistic License 2.0 (GPL Compatible)
=cut
1; # End of Module::Generate