Class yii\apidoc\models\ParamDoc

Inheritanceyii\apidoc\models\ParamDoc » yii\base\Object
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/models/ParamDoc.php

Represents API documentation information for a function or method param.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Object
__construct() yii\apidoc\models\ParamDoc
__get() Returns the value of an object property. yii\base\Object
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Object
__set() Sets value of an object property. yii\base\Object
__unset() Sets an object property to null. yii\base\Object
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Object
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Object
className() Returns the fully qualified name of this class. yii\base\Object
hasMethod() Returns a value indicating whether a method is defined. yii\base\Object
hasProperty() Returns a value indicating whether a property is defined. yii\base\Object
init() Initializes the object. yii\base\Object

Property Details

$defaultValue public property
public $defaultValue null
$description public property
public $description null
$isOptional public property
public $isOptional null
$isPassedByReference public property
public $isPassedByReference null
$name public property
public $name null
$sourceFile public property
public $sourceFile null
$type public property
public $type null
$typeHint public property
public $typeHint null
$types public property
public $types null

Method Details

__construct() public method

public void __construct ( $reflector null, $context null, $config = [] )
$reflector \phpDocumentor\Reflection\FunctionReflector\ArgumentReflector
$context yii\apidoc\models\Context
$config array