=pod

=for comment
DO NOT EDIT. This Pod was generated by Swim v0.1.30.
See http://github.com/ingydotnet/swim-pm#readme

=encoding utf8

=head1 NAME

Inline::Module - Support for Inline-based CPAN Extension Modules

=for html
<a href="https://travis-ci.org/ingydotnet/inline-module-pm"><img src="https://travis-ci.org/ingydotnet/inline-module-pm.png" alt="inline-module-pm"></a>
<a href="https://coveralls.io/r/ingydotnet/inline-module-pm?branch=master"><img src="https://coveralls.io/repos/ingydotnet/inline-module-pm/badge.png" alt="inline-module-pm"></a>

=head1 SYNOPSIS

In C<Makefile.PL>:

    use ExtUtils::MakeMaker;
    WriteMakefile(
      NAME => 'Module::Name',
      ...,
    );

    use lib 'inc';
    use Inline::Module::MakeMaker;
    FixMakefile(module => 'Module::Name');

=head1 DESCRIPTION

This module provides support and documentation for creating and maintaining
CPAN extension modules. ie Writing XS modules without having to learn XS.

The L<Inline::Module::Tutorial> explains the simple processes involved.

When used from a C<Makefile.PL>, this module provides support for modifying
the Makefile generated by L<ExtUtils::MakeMaker>.

=head1 EXPORTS

This module exports C<FixMakefile> when used from a C<Makefile.PL>.

C<FixMakefile> takes the following arguments:

=head2 Arguments

Arguments are key/value pairs.

=over

=item C<module>

    module => 'My::Module',

Required. This is the module that contains inline C<C> or C<C++> code. It can
be an array ref of multiple modules.

=item C<inline>

    inline => 'My::Module::Inline',

Optional. This is the name of the Inline::Module generated stub module. It's
value defaults to the C<module> argument with '::Inline' appended. It can be
an array ref of multiple modules.

=item C<ilsm>

    ilsm => 'Inline::CPP',

Optional. This is the Inline Language Support Module (ilsm) that you are
using. It defaults to L<Inline::C>. It can be an array ref of multiple ilsm-s.

=back

=head1 SCRIPT

This module provides a script to generate a required Inline stub file.

    > perl-inline-module generate Module::Name::Inline
    Inline module 'Module::Name::Inline' generated as 'lib/Module/Name/Inline.pm'

=head1 TPF GRANT

This module was written as the major portion of the work for a 2014 Perl
Foundation grant:

L<http://news.perlfoundation.org/2014/09/grant-proposal-inlinecpp-modul.html>

=head1 SEE

=over

=item * L<Inline::Module::Tutorial>

=item * L<Inline>

=item * L<Inline::C>

=item * L<Inline::CPP>

=back

=head1 NOTE

When this module was first created in November 2014, we belatedly realized
that there was already an Inline::Module on CPAN, by Ingy. The other one is to
"inline" one module inside another. It appears that nobody uses the old one,
but if that is not the case, contact INGY and he'll redo that one under
another name.

=head1 AUTHORS

=over

=item * Ingy döt Net <ingy@cpan.org>

=item * David Oswald <davido@cpan.org>

=back

=head1 COPYRIGHT

Copyright 2014. Ingy döt Net.

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

See L<http://www.perl.com/perl/misc/Artistic.html>

=cut
