Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl Monk, Perl Meditation
 
PerlMonks  

Re: Can POD be included from a seprate file using Pod::Weaver?

by davido (Cardinal)
on Sep 02, 2019 at 19:00 UTC ( [id://11105463]=note: print w/replies, xml ) Need Help??


in reply to Can POD be included from a seprate file using Pod::Weaver?

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.

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


Dave

Replies are listed 'Best First'.
Re^2: Can POD be included from a seprate file using Pod::Weaver?
by LanX (Saint) on Sep 02, 2019 at 19:09 UTC
    > I can't seem to find where this feature is documented

    Right at the beginning? ;)

    perldoc#DESCRIPTION

    perldoc looks up documentation in .pod format that is embedded in the perl installation tree or in a perl script

    Update

    But yeah it could be clearer stated. .pod is an extension POD the format.

    Cheers Rolf
    (addicted to the Perl Programming Language :)
    Wikisyntax for the Monastery FootballPerl is like chess, only without the dice

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://11105463]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others romping around the Monastery: (3)
As of 2024-04-19 20:41 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found