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 |
| addValues | Adds two arguments |
| one | Returns one |
public __construct (array $options)Description
Constructs an object
Parameters
(array) $options
: options
Return Values
void
public addValues (float $one, float $two)Description
Adds two arguments
Parameters
(float) $one
: First argument
(float) $two
: Second argument
Return Values
float
final public static one (void)Description
Returns one
That is long description for one method
written in more then one line
Parameters
This function has no parameters.
Return Values
integer