RE: [PEAR-DEV] PHPod documentation
| From: | Graeme Merrall | Date: | Wed, 01 Aug 2001 01:00:46 +0000 |
| Subject: | RE: [PEAR-DEV] PHPod documentation | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-1207@lists.php.net to get a copy of this message | ||
Curse these timezone differences. Can't everyone move into GMT+10 so I'm not
always out of sync? :)
> For those of us who've never used POD, maybe if someone were to
> explain what
> those (the capabilities of POD-style documentation) are, it would help?
The perlpod docs are online at
http://www.perldoc.com/perl5.6/pod/perlpod.html
Basically you have tags beginning with = including headings etc. You can
also escape in and out of pod/code using =pod and =cut
In addition you can have lists using =begin and =item, and non-parse text
using =for. In addition there are basic formatting commands and
cross-referencing.
There a truckload of pod translaters including text, html, man, rdf, latex
and others.
I have to admit I've never seen it used for describing API stuff tho.
Cheers,
Graeme