Class yii\apidoc\models\FunctionDoc

Inheritanceyii\apidoc\models\FunctionDoc » yii\apidoc\models\BaseDoc » yii\base\BaseObject
Subclassesyii\apidoc\models\MethodDoc
Available since version2.0

Represents API documentation information for a function.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() yii\apidoc\models\FunctionDoc
extractFirstSentence() Extracts first sentence out of text yii\apidoc\models\BaseDoc
getFirstTag() Get the first tag of a given name yii\apidoc\models\BaseDoc
hasTag() Checks if doc has tag of a given name yii\apidoc\models\BaseDoc
removeTag() Removes tag of a given name yii\apidoc\models\BaseDoc

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
mbUcFirst() Multibyte version of ucfirst() yii\apidoc\models\BaseDoc

Property Details

$exceptions public property
public $exceptions = []
$isReturnByReference public property
public $isReturnByReference null
$params public property
$return public property
public $return null
$returnType public property
public $returnType null
$returnTypes public property
public $returnTypes null

Method Details

__construct() public method

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