Re: Documentation Generation
| From: | Ulf Wendel | Date: | Mon, 02 Oct 2000 20:50:45 +0000 |
| Subject: | Re: Documentation Generation | ||
| References: | 1 2 3 | Groups: | php.pear |
| Request: | Send a blank email to php-pear+get-314@lists.php.net to get a copy of this message | ||
Chuck Hagenbuch wrote:
>
> Quoting Ulf Wendel <ulf.wendel@redsys.de>:
>
> > I use PHPDoc1.0alpha - here's a preview of the results:
> > http://www.redsys.de/phpdoc/doc/pear/index2.html.
>
> Ooh, that looks nice. Does this version support multi-line @param comments?
> That's maybe my biggest issue with the 0.2 version...
You mean @param $foo1, $foo2, $foo3 ? No, this is not supported. The
syntax is:
@param (object objectname|type) [$varname] [description]
And no, it was not a design goal to have user defined tag sets. A patch
would take me about 4 hours - but I do not like the syntax and we should
discuss which one is better.
> > The generator will be available tomorrow. Is there still any interest to
> > check in PHPDoc to the PEAR repository?
>
> I'd love to see it in cvs somewhere, and I certainly wouldn't object to
> having a PHPDoc subdir in the pear tree. However, I think that'd take some
> thought as to how (and whether, I guess) we want to include applications in
> PEAR - we wouldn't want to include all of the phpdoc files in the main PEAR
> makefile - that'd start to get out of hand.
I can place it on Sourceforge or in the PEAR Repository, or even
introduce a new website and have a (public) CVS at NetUSE. It's up to
the PEAR community.
Ulf