@param

Description

NOTE: as of 0.4.1, @param can document phpdoc.de-style, with optional $paramname

datatype should be a valid PHP type or "mixed", or you can list multiple datatypes for a single parameter by delimiting them with the pipe (e.g. "@param int|string $p1"). You may document parameters listed or any optional paramters that will be parsed by standard PHP functions func_num_args()/get_func_arg(). Recommended name format for parameters listed with func_get_arg() is:

• $paramname if there is only one parameter

• $paramname,... if the number of parameters is unlimited

phpDocumentor will display the optional description unmodified

Example

Here's an example:

/**

 * example of basic @param usage
 * @param bool $baz 
 * @return mixed 
 */
function function1($baz)
{
   if ($baz)
   {
      $a = 5;
   } else
   {
      $a = array(1,4);
   }
   return $a;
}
 
class class1
{
   /**
    * example of documenting a method, and using optional description with @return
    * @return string de-html_entitied string (no entities at all)
    */
   function bar($foo)
   {
      return strtr($foo,array_flip(get_html_translation_table(HTML_ENTITIES)));
   }
}
 
/**
 * Example of documenting multiple possible datatypes for a given parameter
 * @param bool|string $foo sometimes a boolean, sometimes a string (or, could have just used "mixed")
 * @param bool|int $bar sometimes a boolean, sometimes an int (again, could have just used "mixed")
 */
function function2($foo, $bar)
{
   if (!$foo)
   {
      // definitely not a string, and not a boolean TRUE... could ONLY be a boolean FALSE
   }
 
   if (!$bar)
   {
      // could ONLY be a boolean FALSE or an integer "0"
   }
}
 
/**
 * Example of documenting undetermined function arguments
 * @param string $foo 
 * @param mixed $foo_desc optional description of foo
 */
function function3($foo)
{
   echo $foo;
   if (func_num_args == 2)
   {
      echo 'Description: '.func_get_arg(1);
   }
}
 
/**
 * Example of unlimited parameters.
 * Returns a formatted var_dump for debugging purposes
 * @param string $s string to display
 * @param mixed $v variable to display with var_dump()
 * @param mixed $v,... unlimited number of additional variables to display with var_dump()
 */
function fancy_debug($s,$v)
{
   print $s."<blockquote>\n";
   var_dump($v);
   if (func_num_args()>2)
   {
      for($i=2;$i<func_num_args();$i++)
      {
         $a = func_get_arg($i);
         var_dump($a);
         print "<br>\n";
      }}
   print "</blockquote>\n";
}