Class yii\apidoc\models\ParamDoc

All Classes | Properties | Methods
Inheritanceyii\apidoc\models\ParamDoc » yii\base\Object
Available since version2.0

Represents API documentation information for a function or method param.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$defaultValue yii\apidoc\models\ParamDoc
$description yii\apidoc\models\ParamDoc
$isOptional yii\apidoc\models\ParamDoc
$isPassedByReference yii\apidoc\models\ParamDoc
$name yii\apidoc\models\ParamDoc
$sourceFile yii\apidoc\models\ParamDoc
$type yii\apidoc\models\ParamDoc
$typeHint yii\apidoc\models\ParamDoc
$types yii\apidoc\models\ParamDoc

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() yii\apidoc\models\ParamDoc

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