Re: PHPod documentation

On Tue, Jul 31, 2001 at 02:44:16PM +0200, Stig S. Bakken wrote: > But these two systems have slightly different markup syntaxes, JavaDoc > has metadata markup, while POD has formatting markup. What about > combining the two into PHPod: > > we could easily document function parameters etc. with a POD-like format > too, and and a bonus we would not inherit all the features from JavaDoc > that don't really fit too well with PHP, but we can define a format that > is perfect for PHP. What about this: Hmm... I'm not sure which idea I like best here, considering all of the ramifications of each. 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. 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). -- Jon Parise (jon@csh.rit.edu) . Rochester Inst. of Technology http://www.csh.rit.edu/~jon/ : Computer Science House Member