Re: PHPod documentation
| From: | Chuck Hagenbuch | Date: | Tue, 31 Jul 2001 14:25:12 +0000 |
| Subject: | Re: PHPod documentation | ||
| References: | 1 2 3 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-1192@lists.php.net to get a copy of this message | ||
Quoting Jon Parise <jon@php.net>:
> I'm sort of leaning toward developing our own PearDoc system that
> is based on the existing PHPDoc / JavaDoc syntax (because of
> legacy code and familiarity), but I would really like to see the
> capabilities of POD-style documentation be added, too.
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?
> So I think the thing to do is create a PearDoc standard that is a
> superset of JavaDoc (while ignoring some of the irrelevant tags)
> and includes the most helpful features of POD (but not
> necessarily the POS syntax itself).
I'm going to bump investigating the current phpdoc tools (people have been
mentioning phpDocumentor(?) as being good?) and setting something up on the
PEAR site to display docs of all of the classes to near the top of my
priorities. We can go from there?
-chuck
--
Charles Hagenbuch, <chuck@horde.org>
Some fallen angels have their good reasons.