Previous | Up | Next |
@property | phpDocumentor tags | @see |
The @return tag is used to document the return value of functions or methods. @returns is an alias for @return to support tag formats of other automatic documentors
The datatype should be a valid PHP type (int, string, bool, etc), a class name for the type of object returned, or simply "mixed". If you want to explicitly show multiple possible return types, list them pipe-delimited without spaces (e.g. "@return int|string"). If a class name is used as the datatype in the @return tag, phpDocumentor will automatically create a link to that class's documentation. In addition, if a function returns multiple possible values, separate them using the | character, and phpDocumentor will parse out any class names in the return value. phpDocumentor will display the optional description unmodified.
Here's an example:
Previous | Up | Next |
@property | phpDocumentor tags | @see |
Documentation generated on Mon, 05 Dec 2011 21:18:39 -0600 by phpDocumentor 1.4.4