Re[2]: [PEAR] phpDocumentor: undefined parameters count handling
| From: | Katana | Date: | Thu, 02 Jan 2003 19:37:43 +0000 |
| Subject: | Re[2]: [PEAR] phpDocumentor: undefined parameters count handling | ||
| References: | 1 2 3 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-3149@lists.php.net to get a copy of this message | ||
GB> There is an example of how to do this included in the documentation for
GB> @param, and also in phpdoc.inc. Look for the function fancy_debug(), which
GB> takes variable arguments. Basically, it is possible to have more @params in
GB> the function DocBlock than there are function parameters. As Josh says,
GB> there is no rigid format, this is left up to the developer to decide,
GB> although I suggest giving the parameters a name that ends with an ellipsis
GB> (...) like $param...
GB> Anything will work, however.
What I have done right now is use one parameter (the minimum for the
function, and describe the fact that there can be several in the
@param tag for this parameter.
Of course, there is no "perfect" way, I was just looking for the
elegant and logic one.
Thanks,
Katana