From 2fa057da21a5472887ddf73fa8e5dbb355096f85 Mon Sep 17 00:00:00 2001 From: Evgeniy Tkachenko Date: Fri, 14 Jan 2022 23:20:57 +0300 Subject: [PATCH] docs: correct Syntax for phpDoc (#495) Co-authored-by: githubjeka --- .../controller/default/controller.php | 4 ++-- src/generators/controller/default/view.php | 8 ++++---- src/generators/controller/form.php | 6 +++--- src/generators/crud/default/controller.php | 4 ++-- src/generators/crud/default/search.php | 4 ++-- src/generators/crud/default/views/_form.php | 10 +++++----- src/generators/crud/default/views/_search.php | 10 +++++----- src/generators/crud/default/views/create.php | 8 ++++---- src/generators/crud/default/views/index.php | 10 +++++----- src/generators/crud/default/views/update.php | 8 ++++---- src/generators/crud/default/views/view.php | 8 ++++---- src/generators/crud/form.php | 6 +++--- src/generators/extension/form.php | 6 +++--- src/generators/form/default/action.php | 4 ++-- src/generators/form/default/form.php | 10 +++++----- src/generators/form/form.php | 6 +++--- src/generators/model/default/model.php | 20 +++++++++---------- src/generators/model/default/query.php | 20 +++++++++---------- src/generators/model/form.php | 8 ++++---- src/generators/module/default/controller.php | 4 ++-- src/generators/module/default/module.php | 4 ++-- src/generators/module/default/view.php | 4 ++-- src/generators/module/form.php | 6 +++--- src/views/default/diff.php | 4 ++-- src/views/default/index.php | 6 +++--- src/views/default/view.php | 16 +++++++-------- src/views/default/view/files.php | 10 +++++----- src/views/default/view/results.php | 8 ++++---- src/views/layouts/generator.php | 8 ++++---- src/views/layouts/main.php | 4 ++-- 30 files changed, 117 insertions(+), 117 deletions(-) diff --git a/src/generators/controller/default/controller.php b/src/generators/controller/default/controller.php index bc3888027..f6d180f1e 100644 --- a/src/generators/controller/default/controller.php +++ b/src/generators/controller/default/controller.php @@ -6,8 +6,8 @@ use yii\helpers\Inflector; use yii\helpers\StringHelper; -/* @var $this yii\web\View */ -/* @var $generator yii\gii\generators\controller\Generator */ +/** @var yii\web\View $this */ +/** @var yii\gii\generators\controller\Generator $generator */ echo " diff --git a/src/generators/controller/default/view.php b/src/generators/controller/default/view.php index c46b542af..bad7e26ae 100644 --- a/src/generators/controller/default/view.php +++ b/src/generators/controller/default/view.php @@ -3,13 +3,13 @@ * This is the template for generating an action view file. */ -/* @var $this yii\web\View */ -/* @var $generator yii\gii\generators\controller\Generator */ -/* @var $action string the action ID */ +/** @var yii\web\View $this */ +/** @var yii\gii\generators\controller\Generator $generator */ +/** @var string $action the action ID */ echo " -/* @var $this yii\web\View */ +/** @var yii\web\View $this */ " ?>

getControllerSubPath() . $generator->getControllerID() . '/' . $action ?>

diff --git a/src/generators/controller/form.php b/src/generators/controller/form.php index 9a6e8cd2f..c2df86448 100644 --- a/src/generators/controller/form.php +++ b/src/generators/controller/form.php @@ -1,7 +1,7 @@ field($generator, 'controllerClass'); echo $form->field($generator, 'actions'); diff --git a/src/generators/crud/default/controller.php b/src/generators/crud/default/controller.php index 289541efe..b4f0aab9b 100644 --- a/src/generators/crud/default/controller.php +++ b/src/generators/crud/default/controller.php @@ -7,8 +7,8 @@ use yii\helpers\StringHelper; -/* @var $this yii\web\View */ -/* @var $generator yii\gii\generators\crud\Generator */ +/** @var yii\web\View $this */ +/** @var yii\gii\generators\crud\Generator $generator */ $controllerClass = StringHelper::basename($generator->controllerClass); $modelClass = StringHelper::basename($generator->modelClass); diff --git a/src/generators/crud/default/search.php b/src/generators/crud/default/search.php index 0ca91d454..81654b3b0 100644 --- a/src/generators/crud/default/search.php +++ b/src/generators/crud/default/search.php @@ -6,8 +6,8 @@ use yii\helpers\StringHelper; -/* @var $this yii\web\View */ -/* @var $generator yii\gii\generators\crud\Generator */ +/** @var yii\web\View $this */ +/** @var yii\gii\generators\crud\Generator $generator */ $modelClass = StringHelper::basename($generator->modelClass); $searchModelClass = StringHelper::basename($generator->searchModelClass); diff --git a/src/generators/crud/default/views/_form.php b/src/generators/crud/default/views/_form.php index 0720887f6..213442d0e 100644 --- a/src/generators/crud/default/views/_form.php +++ b/src/generators/crud/default/views/_form.php @@ -3,8 +3,8 @@ use yii\helpers\Inflector; use yii\helpers\StringHelper; -/* @var $this yii\web\View */ -/* @var $generator yii\gii\generators\crud\Generator */ +/** @var yii\web\View $this */ +/** @var yii\gii\generators\crud\Generator $generator */ /* @var $model \yii\db\ActiveRecord */ $model = new $generator->modelClass(); @@ -19,9 +19,9 @@ use yii\helpers\Html; use yii\widgets\ActiveForm; -/* @var $this yii\web\View */ -/* @var $model modelClass, '\\') ?> */ -/* @var $form yii\widgets\ActiveForm */ +/** @var yii\web\View $this */ +/** @var modelClass, '\\') ?> $model */ +/** @var yii\widgets\ActiveForm $form */ ?>
diff --git a/src/generators/crud/default/views/_search.php b/src/generators/crud/default/views/_search.php index b65231fc5..9d9251fe4 100644 --- a/src/generators/crud/default/views/_search.php +++ b/src/generators/crud/default/views/_search.php @@ -3,8 +3,8 @@ use yii\helpers\Inflector; use yii\helpers\StringHelper; -/* @var $this yii\web\View */ -/* @var $generator yii\gii\generators\crud\Generator */ +/** @var yii\web\View $this */ +/** @var yii\gii\generators\crud\Generator $generator */ echo " @@ -12,9 +12,9 @@ use yii\helpers\Html; use yii\widgets\ActiveForm; -/* @var $this yii\web\View */ -/* @var $model searchModelClass, '\\') ?> */ -/* @var $form yii\widgets\ActiveForm */ +/** @var yii\web\View $this */ +/** @var searchModelClass, '\\') ?> $model */ +/** @var yii\widgets\ActiveForm $form */ ?>