phpdoc comments for arguments read via func_get_args()
| From: | Lukas Smith | Date: | Fri, 27 Jan 2006 08:26:22 +0000 |
| Subject: | phpdoc comments for arguments read via func_get_args() | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-41104@lists.php.net to get a copy of this message | ||
Hi,
what is the preferred way of documenting methods that can accept an arbitrary (with potentially a minimum) number of parameters.
for example here i want to support 2 or more parameters.
/**
* returns string to concatenate two or more string parameters
*
* @return string to caoncatenate two strings
* @access public
*/
function concat($value1, $value2)
{
$args = func_get_args();
return "(".implode(' || ', $args).")";
}
regards,
Lukas