Class yii\apidoc\models\TraitDoc

All Classes | Properties | Methods

Inheritance	yii\apidoc\models\TraitDoc » yii\apidoc\models\TypeDoc » yii\apidoc\models\BaseDoc » yii\base\Object
Implements	yii\base\Configurable
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-apidoc/blob/master/models/TraitDoc.php

Represents API documentation information for a trait.

Public Properties

Property	Type	Defined By
$authors		yii\apidoc\models\TypeDoc
$deprecatedReason		yii\apidoc\models\BaseDoc
$deprecatedSince		yii\apidoc\models\BaseDoc
$description		yii\apidoc\models\BaseDoc
$endLine		yii\apidoc\models\BaseDoc
$methods	yii\apidoc\models\MethodDoc[]	yii\apidoc\models\TypeDoc
$name		yii\apidoc\models\BaseDoc
$namespace		yii\apidoc\models\TypeDoc
$nativeMethods	yii\apidoc\models\MethodDoc[]	yii\apidoc\models\TypeDoc
$nativeProperties	yii\apidoc\models\PropertyDoc[]	yii\apidoc\models\TypeDoc
$phpDocContext	\phpDocumentor\Reflection\DocBlock\Context	yii\apidoc\models\BaseDoc
$properties	yii\apidoc\models\PropertyDoc[]	yii\apidoc\models\TypeDoc
$protectedMethods	yii\apidoc\models\MethodDoc[]	yii\apidoc\models\TypeDoc
$protectedProperties	yii\apidoc\models\PropertyDoc[]	yii\apidoc\models\TypeDoc
$publicMethods	yii\apidoc\models\MethodDoc[]	yii\apidoc\models\TypeDoc
$publicProperties	yii\apidoc\models\PropertyDoc[]	yii\apidoc\models\TypeDoc
$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
$traits		yii\apidoc\models\TraitDoc
$usedBy		yii\apidoc\models\TraitDoc

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Object
__construct()		yii\apidoc\models\TraitDoc
__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
extractFirstSentence()	Extracts first sentence out of text	yii\apidoc\models\BaseDoc
findSubject()	Finds subject (method or property) by name	yii\apidoc\models\TypeDoc
getNativeMethods()		yii\apidoc\models\TypeDoc
getNativeProperties()		yii\apidoc\models\TypeDoc
getProtectedMethods()		yii\apidoc\models\TypeDoc
getProtectedProperties()		yii\apidoc\models\TypeDoc
getPublicMethods()		yii\apidoc\models\TypeDoc
getPublicProperties()		yii\apidoc\models\TypeDoc
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
hasTag()	Checks if doc has tag of a given name	yii\apidoc\models\BaseDoc
init()	Initializes the object.	yii\base\Object
removeTag()	Removes tag of a given name	yii\apidoc\models\BaseDoc

$traits public property

$usedBy public property

__construct() public method

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