With Perl if you store a file alongside your module with the same name but with a .pod extension instead of a .pm extension, perldoc will find it. If you're packing for CPAN make sure your MANIFEST includes it, though.

$ cat lib/Mymod.pm
package Mymod;

use strict;
use warnings;
use Exporter;
our @EXPORT = qw(greet);

sub greet {print "Hello\n"}

1;

.....


$ cat lib/Mymod.pod 
=pod

=head1 NAME

Mymod - Perl module to say hello.

=head1 SYNOPSIS

    use Mymod;
    greet();

=head1 DESCRIPTION

Example module.

=cut


.......

$ PERL5LIB='./lib' perldoc -T Mymod
NAME
    Mymod - Perl module to say hello.

SYNOPSIS
        use Mymod;
        greet();

DESCRIPTION
    Example module.

[download]

I can't seem to find where this feature is documented, but it's not hard to find it in use on CPAN.


Dave

In reply to Re: Can POD be included from a seprate file using Pod::Weaver? by davido
in thread Can POD be included from a seprate file using Pod::Weaver? by nysus

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.