Re: phpDocumentor: undefined parameters count handling
| From: | Greg Beaver | Date: | Thu, 02 Jan 2003 19:28:40 +0000 |
| Subject: | Re: phpDocumentor: undefined parameters count handling | ||
| References: | 1 2 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-3145@lists.php.net to get a copy of this message | ||
Hi Bertrand
There is an example of how to do this included in the documentation for
@param, and also in phpdoc.inc. Look for the function fancy_debug(), which
takes variable arguments. Basically, it is possible to have more @params in
the function DocBlock than there are function parameters. As Josh says,
there is no rigid format, this is left up to the developer to decide,
although I suggest giving the parameters a name that ends with an ellipsis
(...) like $param...
Anything will work, however.
Take care,
Greg
----- Original Message -----
From: "Joshua Eichorn" <jeichorn@joshuaeichorn.com>
To: "Bertrand DUNOGIER" <bdunogier@wanadoo.fr>
Cc: <pear-general@lists.php.net>; "Greg Beaver" <beavergr@pilot.msu.edu>
Sent: Thursday, January 02, 2003 10:23 AM
Subject: Re: [PEAR] phpDocumentor: undefined parameters count handling
> For documentation purposes you should be able to just specify the
> @param's, however this isn't anything built into that syntax to support
> optional paramters.
> -joshua eichorn
> jeichorn@phpdoc.org
> Katana wrote:
>
> >Hello,
> >
> >did anyone think of an elegant way to handle variable argument number
> >functions ? Not default values nor arrays, but using func_num_args,
> >func_get_args and so on.
> >
> >Katana
> >
> >
> >
> >
>
>