Re: Documentation Generation
| From: | Chuck Hagenbuch | Date: | Mon, 02 Oct 2000 21:05:24 +0000 |
| Subject: | Re: Documentation Generation | ||
| References: | 1 2 3 4 | Groups: | php.pear |
| Request: | Send a blank email to php-pear+get-315@lists.php.net to get a copy of this message | ||
Quoting Ulf Wendel <ulf.wendel@redsys.de>:
> You mean @param $foo1, $foo2, $foo3 ? No, this is not supported. The
> syntax is:
>
> @param (object objectname|type) [$varname] [description]
Actually, no, I meant @param string $foo [multi-line description]
[... more decription ]
The 0.2 version that I have chops things off after the first line, while a
fair number of my parameter descriptions stretch onto multiple lines,
especially if you try and keep line lengths reasonable...
> 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.
Hmm? You kind of lost me here - how did we get to user defined tag sets?
> 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.
Hmm. Sourceforge is a nice infrastructure; I'd vote either for that or the
PEAR repository, depending on whether or not the community wants to adopt
PHPDoc as the official documentation generator, and whether or not you
_want_ it to take on that status.
-chuck
--
Charles Hagenbuch, <chuck@horde.org>
--
" ... I mean, who wouldn't look forward to waking up in the morning and
having a nice big bowl of frosted For-Next Loops ... " - Slashdot comment