Skip to content

Commit

Permalink
@inheritdoc notation fix
Browse files Browse the repository at this point in the history
  • Loading branch information
klimov-paul committed Nov 3, 2017
1 parent 40f0321 commit da0d874
Show file tree
Hide file tree
Showing 24 changed files with 93 additions and 90 deletions.
2 changes: 1 addition & 1 deletion ActiveFixture.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class ActiveFixture extends BaseActiveFixture


/**
* @inheritdoc
* {@inheritdoc}
*/
public function init()
{
Expand Down
2 changes: 1 addition & 1 deletion ActiveQuery.php
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public function init()
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function prepare()
{
Expand Down
4 changes: 2 additions & 2 deletions ActiveRecord.php
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public static function deleteAll($condition = [], $options = [])
}

/**
* @inheritdoc
* {@inheritdoc}
* @return ActiveQuery the newly created [[ActiveQuery]] instance.
*/
public static function find()
Expand Down Expand Up @@ -356,7 +356,7 @@ public function equals($record)
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function toArray(array $fields = [], array $expand = [], $recursive = true)
{
Expand Down
10 changes: 5 additions & 5 deletions console/controllers/MigrateController.php
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ class MigrateController extends BaseMigrateController
*/
public $migrationCollection = 'migration';
/**
* @inheritdoc
* {@inheritdoc}
*/
public $templateFile = '@yii/mongodb/views/migration.php';
/**
Expand All @@ -89,7 +89,7 @@ class MigrateController extends BaseMigrateController


/**
* @inheritdoc
* {@inheritdoc}
*/
public function options($actionID)
{
Expand Down Expand Up @@ -146,7 +146,7 @@ protected function createMigration($class)
}

/**
* @inheritdoc
* {@inheritdoc}
*/
protected function getMigrationHistory($limit)
{
Expand Down Expand Up @@ -221,7 +221,7 @@ protected function ensureBaseMigrationHistory()
}

/**
* @inheritdoc
* {@inheritdoc}
*/
protected function addMigrationHistory($version)
{
Expand All @@ -232,7 +232,7 @@ protected function addMigrationHistory($version)
}

/**
* @inheritdoc
* {@inheritdoc}
*/
protected function removeMigrationHistory($version)
{
Expand Down
16 changes: 8 additions & 8 deletions debug/MongoDbPanel.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@
class MongoDbPanel extends DbPanel
{
/**
* @inheritdoc
* {@inheritdoc}
*/
public $db = 'mongodb';


/**
* @inheritdoc
* {@inheritdoc}
*/
public function init()
{
Expand All @@ -40,23 +40,23 @@ public function init()
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function getName()
{
return 'MongoDB';
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function getSummaryName()
{
return 'MongoDB';
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function getDetail()
{
Expand Down Expand Up @@ -92,15 +92,15 @@ public function getProfileLogs()
}

/**
* @inheritdoc
* {@inheritdoc}
*/
protected function hasExplain()
{
return true;
}

/**
* @inheritdoc
* {@inheritdoc}
*/
protected function getQueryType($timing)
{
Expand All @@ -112,7 +112,7 @@ protected function getQueryType($timing)
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public static function canBeExplained($type)
{
Expand Down
2 changes: 1 addition & 1 deletion file/ActiveQuery.php
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public function init()
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function buildCursor($db = null)
{
Expand Down
2 changes: 1 addition & 1 deletion file/ActiveRecord.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
abstract class ActiveRecord extends \yii\mongodb\ActiveRecord
{
/**
* @inheritdoc
* {@inheritdoc}
* @return ActiveQuery the newly created [[ActiveQuery]] instance.
*/
public static function find()
Expand Down
6 changes: 3 additions & 3 deletions file/Collection.php
Original file line number Diff line number Diff line change
Expand Up @@ -134,15 +134,15 @@ public function getFileCollection($refresh = false)
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function drop()
{
return parent::drop() && $this->database->dropCollection($this->getChunkCollection()->name);
}

/**
* @inheritdoc
* {@inheritdoc}
* @return Cursor cursor for the search results
*/
public function find($condition = [], $fields = [], $options = [])
Expand All @@ -151,7 +151,7 @@ public function find($condition = [], $fields = [], $options = [])
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function remove($condition = [], $options = [])
{
Expand Down
2 changes: 1 addition & 1 deletion file/Upload.php
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public function __destruct()
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function init()
{
Expand Down
18 changes: 9 additions & 9 deletions gii/model/Generator.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,23 @@ class Generator extends \yii\gii\Generator


/**
* @inheritdoc
* {@inheritdoc}
*/
public function getName()
{
return 'MongoDB Model Generator';
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function getDescription()
{
return 'This generator generates an ActiveRecord class for the specified MongoDB collection.';
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function rules()
{
Expand All @@ -73,7 +73,7 @@ public function rules()
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function attributeLabels()
{
Expand All @@ -88,7 +88,7 @@ public function attributeLabels()
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function hints()
{
Expand All @@ -108,7 +108,7 @@ public function hints()
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function autoCompleteData()
{
Expand All @@ -126,23 +126,23 @@ public function autoCompleteData()
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function requiredTemplates()
{
return ['model.php'];
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function stickyAttributes()
{
return array_merge(parent::stickyAttributes(), ['ns', 'db', 'baseClass']);
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function generate()
{
Expand Down
8 changes: 4 additions & 4 deletions gii/model/default/model.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
class <?= $className ?> extends <?= '\\' . ltrim($generator->baseClass, '\\') . "\n" ?>
{
/**
* @inheritdoc
* {@inheritdoc}
*/
public static function collectionName()
{
Expand All @@ -50,7 +50,7 @@ public static function getDb()
<?php endif; ?>

/**
* @inheritdoc
* {@inheritdoc}
*/
public function attributes()
{
Expand All @@ -62,15 +62,15 @@ public function attributes()
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function rules()
{
return [<?= "\n " . implode(",\n ", $rules) . "\n " ?>];
}

/**
* @inheritdoc
* {@inheritdoc}
*/
public function attributeLabels()
{
Expand Down
Loading

0 comments on commit da0d874

Please sign in to comment.