Beefy Boxes and Bandwidth Generously Provided by pair Networks
Do you know where your variables are?
 
PerlMonks  

Re: Re: Crash Course in POD

by jens (Pilgrim)
on Sep 25, 2002 at 02:40 UTC ( #200544=note: print w/ replies, xml ) Need Help??


in reply to Re: Crash Course in POD
in thread Crash Course in POD

Single point of documentation
<snip>... I'd write the POD into all the scripts and then copy the useful bits into a separate file. It's more work, but it'll be more useful to the next coder.


Having a single point of documentation is one of the most important reasons I want to use POD--that way a change to the commented source is immediately reflected in the Programmer's Manual.

But when you say to "copy the useful bits into a separate file" this doesn't solve the problem.

Is there a way, in POD, to accumulate POD comments in multiple files into one larger document? This way there would truly be a single point of documentation.

--
Microsoft delendum est.


Comment on Re: Re: Crash Course in POD
Re x 3: Crash Course in POD
by Sweeper (Pilgrim) on Sep 25, 2002 at 05:44 UTC
    Is there a way, in POD, to accumulate POD comments in multiple files into one larger document? This way there would truly be a single point of documentation.

    There is no way in POD, but there are many ways in Perl (at least, there is more than one way...) Go to http://www.cpan.org/modules/01modules.index.html and you will find more than 30 modules dealing with POD. In your case, maybe Pod-Simple or Pod-Parser is what you need.

    With either module, extract the POD from each file and copy it to the result file. That's simple.

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others musing on the Monastery: (10)
As of 2014-09-01 07:49 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    The best computer themed movie is:











    Results (299 votes), past polls