Class yii\apidoc\models\MethodDoc

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

Represents API documentation information for a method.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() yii\apidoc\models\MethodDoc
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

$definedBy public property
public $definedBy null
$isAbstract public property
public $isAbstract null
$isFinal public property
public $isFinal null
$isStatic public property
public $isStatic null
$visibility public property
public $visibility null

Method Details

__construct() public method

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