Example_Class is a sample class for demonstrating PHPDoc
Example_Class is a class that has no real actual code, but merely exists to help provide people with an understanding as to how the various PHPDoc tags are used.
| Name | Description |
|---|---|
| __construct | Constructs an object of some specific type with certain unspoken defaults. |
| addValues | Adds two arguments |
| one | Returns one |
Description
public __construct (array $options)Constructs an object of some specific type with certain unspoken defaults.
Parameters
(array) $options: the user's desired settings for the object being
created.
Return Values
void
Description
public addValues (float $one, float $two)Adds two arguments
Parameters
(float) $one: First argument(float) $two: Second argument
Return Values
float
Throws Exceptions
\InvalidArgumentException
Thrown when a param is invalid
\RuntimeException
Thrown when something happens at runtime
Description
final public static one (void)Returns one
That is long description for one method
written in more then one line
Parameters
This function has no parameters.
Return Values
int