@return

@return --  describes the return value of a function

Synopsis

@return { type|objectdefinition } [ $varname ] [ description ]

Scope

Note

If no @return keyword is given, PHPDoc uses void. The keyword is ignored, if (miss-)used in a constructor function.

Example

...
* @return mixed a PEAR_Error object or an integer

* @return boolean true, if successful
...