Class yii\apidoc\models\FunctionDoc

All Classes | Properties | Methods
Inheritanceyii\apidoc\models\FunctionDoc » yii\apidoc\models\BaseDoc » yii\base\Object
Subclassesyii\apidoc\models\MethodDoc
Available since version2.0

Represents API documentation information for a function.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$deprecatedReason yii\apidoc\models\BaseDoc
$deprecatedSince yii\apidoc\models\BaseDoc
$description yii\apidoc\models\BaseDoc
$endLine yii\apidoc\models\BaseDoc
$exceptions yii\apidoc\models\FunctionDoc
$isReturnByReference yii\apidoc\models\FunctionDoc
$name yii\apidoc\models\BaseDoc
$params yii\apidoc\models\ParamDoc[] yii\apidoc\models\FunctionDoc
$phpDocContext \phpDocumentor\Reflection\DocBlock\Context yii\apidoc\models\BaseDoc
$return yii\apidoc\models\FunctionDoc
$returnType yii\apidoc\models\FunctionDoc
$returnTypes yii\apidoc\models\FunctionDoc
$shortDescription yii\apidoc\models\BaseDoc
$since yii\apidoc\models\BaseDoc
$sourceFile yii\apidoc\models\BaseDoc
$startLine yii\apidoc\models\BaseDoc
$tags \phpDocumentor\Reflection\DocBlock\Tag[] yii\apidoc\models\BaseDoc

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
public yii\apidoc\models\ParamDoc[] $params = []
$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