# Class yii\apidoc\models\BaseDoc

Inheritance | yii\apidoc\models\BaseDoc » yii\base\BaseObject
Implements | yii\base\Configurable
Subclasses | yii\apidoc\models\ClassDoc, yii\apidoc\models\ConstDoc, yii\apidoc\models\EventDoc, yii\apidoc\models\FunctionDoc, yii\apidoc\models\InterfaceDoc, yii\apidoc\models\MethodDoc, yii\apidoc\models\PropertyDoc, yii\apidoc\models\TraitDoc, yii\apidoc\models\TypeDoc
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/models/BaseDoc.php

Base class for API documentation information.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$deprecatedReason |  |  | yii\apidoc\models\BaseDoc
$deprecatedSince |  |  | yii\apidoc\models\BaseDoc
$description |  |  | yii\apidoc\models\BaseDoc
$endLine |  |  | yii\apidoc\models\BaseDoc
$name |  |  | yii\apidoc\models\BaseDoc
$packageName | string|null |  | yii\apidoc\models\BaseDoc
$phpDocContext | \phpDocumentor\Reflection\DocBlock\Context |  | yii\apidoc\models\BaseDoc
$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

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\BaseObject
__construct() |  | yii\apidoc\models\BaseDoc
__get() | Returns the value of an object property. | yii\base\BaseObject
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject
__set() | Sets value of an object property. | yii\base\BaseObject
__unset() | Sets an object property to null. | yii\base\BaseObject
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
extractFirstSentence() | Extracts first sentence out of text | yii\apidoc\models\BaseDoc
getFirstTag() | Get the first tag of a given name | yii\apidoc\models\BaseDoc
getPackageName() | Returns the Composer package for this type, if it can be determined from $sourceFile. | yii\apidoc\models\BaseDoc
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject
hasTag() | Checks if doc has tag of a given name | yii\apidoc\models\BaseDoc
init() | Initializes the object. | yii\base\BaseObject
removeTag() | Removes tag of a given name | yii\apidoc\models\BaseDoc

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
mbUcFirst() | Multibyte version of ucfirst() | yii\apidoc\models\BaseDoc

## Property Details

$deprecatedReason public property
public $deprecatedReason = null
$deprecatedSince public property
public $deprecatedSince = null
$description public property
public $description = null
$endLine public property
public $endLine = null
$name public property
public $name = null
$packageName public read-only property (available since version 2.1.3)
public string|null getPackageName ( )
$phpDocContext public property
public \phpDocumentor\Reflection\DocBlock\Context $phpDocContext = null
$shortDescription public property
public $shortDescription = null
$since public property
public $since = null
$sourceFile public property
public $sourceFile = null
$startLine public property
public $startLine = null
$tags public property
public \phpDocumentor\Reflection\DocBlock\Tag[] $tags = []

## Method Details

__construct() public method

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

extractFirstSentence() public static method

Extracts first sentence out of text

public static string extractFirstSentence ( $text )
$text | string |

getFirstTag() public method (available since version 2.0.5)

Get the first tag of a given name

public \phpDocumentor\Reflection\DocBlock\Tag|null getFirstTag ( $name )
$name | string | Tag name.
return | \phpDocumentor\Reflection\DocBlock\Tag|null | Tag instance, `null` if not found.

getPackageName() public method (available since version 2.1.3)

Returns the Composer package for this type, if it can be determined from $sourceFile.

public string|null getPackageName ( )

hasTag() public method

Checks if doc has tag of a given name

public boolean hasTag ( $name )
$name | string | Tag name
return | boolean | If doc has tag of a given name

mbUcFirst() protected static method (available since version 2.0.6)

Multibyte version of ucfirst()

protected static void mbUcFirst ( $string )
$string |  |

removeTag() public method

Removes tag of a given name

public void removeTag ( $name )
$name | string |