Re: Re: 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

Replies are listed 'Best First'.
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.	[reply]

Replies are listed 'Best First'.

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.

[reply]