Fixes yiisoft#3793: Changed inline autocomplete hints style to get mo…

…re IDEs support
switchy · Jun 20, 2014 · 0c14f47 · 0c14f47
1 parent 0ab4da0
commit 0c14f47
Show file tree

Hide file tree

Showing 186 changed files with 641 additions and 818 deletions.
diff --git a/apps/advanced/backend/views/layouts/main.php b/apps/advanced/backend/views/layouts/main.php
@@ -5,10 +5,9 @@
 use yii\bootstrap\NavBar;
 use yii\widgets\Breadcrumbs;
 
-/**
- * @var \yii\web\View $this
- * @var string $content
- */
+/* @var $this \yii\web\View */
+/* @var $content string */
+
 AppAsset::register($this);
 ?>
 <?php $this->beginPage() ?>

diff --git a/apps/advanced/backend/views/site/error.php b/apps/advanced/backend/views/site/error.php
@@ -2,12 +2,10 @@
 
 use yii\helpers\Html;
 
-/**
- * @var yii\web\View $this
- * @var string $name
- * @var string $message
- * @var Exception $exception
- */
+/* @var $this yii\web\View */
+/* @var $name string */
+/* @var $message string */
+/* @var $exception Exception */
 
 $this->title = $name;
 ?>

diff --git a/apps/advanced/backend/views/site/index.php b/apps/advanced/backend/views/site/index.php
@@ -1,7 +1,6 @@
 <?php
-/**
- * @var yii\web\View $this
- */
+/* @var $this yii\web\View */
+
 $this->title = 'My Yii Application';
 ?>
 <div class="site-index">

diff --git a/apps/advanced/backend/views/site/login.php b/apps/advanced/backend/views/site/login.php
@@ -2,11 +2,10 @@
 use yii\helpers\Html;
 use yii\widgets\ActiveForm;
 
-/**
- * @var yii\web\View $this
- * @var yii\widgets\ActiveForm $form
- * @var \common\models\LoginForm $model
- */
+/* @var $this yii\web\View */
+/* @var $form yii\widgets\ActiveForm */
+/* @var $model \common\models\LoginForm */
+
 $this->title = 'Login';
 $this->params['breadcrumbs'][] = $this->title;
 ?>

diff --git a/apps/advanced/common/mail/layouts/html.php b/apps/advanced/common/mail/layouts/html.php
@@ -1,10 +1,9 @@
 <?php
 use yii\helpers\Html;
 
-/**
- * @var \yii\web\View $this
- * @var string $content
- */
+/* @var $this \yii\web\View */
+/* @var $content string */
+
 ?>
 <?php $this->beginPage() ?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

diff --git a/apps/advanced/common/mail/passwordResetToken.php b/apps/advanced/common/mail/passwordResetToken.php
@@ -1,10 +1,8 @@
 <?php
 use yii\helpers\Html;
 
-/**
- * @var yii\web\View $this
- * @var common\models\User $user
- */
+/* @var $this yii\web\View */
+/* @var $user common\models\User */
 
 $resetLink = Yii::$app->urlManager->createAbsoluteUrl(['site/reset-password', 'token' => $user->password_reset_token]);
 ?>

diff --git a/apps/advanced/frontend/models/PasswordResetRequestForm.php b/apps/advanced/frontend/models/PasswordResetRequestForm.php
@@ -35,7 +35,7 @@ public function rules()
  */
  public function sendEmail()
  {
- /** @var User $user */
+ /* @var $user User */
  $user = User::findOne([
  'status' => User::STATUS_ACTIVE,
  'email' => $this->email,

diff --git a/apps/advanced/frontend/views/layouts/main.php b/apps/advanced/frontend/views/layouts/main.php
@@ -6,10 +6,9 @@
 use frontend\assets\AppAsset;
 use frontend\widgets\Alert;
 
-/**
- * @var \yii\web\View $this
- * @var string $content
- */
+/* @var $this \yii\web\View */
+/* @var $content string */
+
 AppAsset::register($this);
 ?>
 <?php $this->beginPage() ?>

diff --git a/apps/advanced/frontend/views/site/about.php b/apps/advanced/frontend/views/site/about.php
@@ -1,9 +1,7 @@
 <?php
 use yii\helpers\Html;
 
-/**
- * @var yii\web\View $this
- */
+/* @var $this yii\web\View */
 $this->title = 'About';
 $this->params['breadcrumbs'][] = $this->title;
 ?>

diff --git a/apps/advanced/frontend/views/site/contact.php b/apps/advanced/frontend/views/site/contact.php
@@ -3,11 +3,10 @@
 use yii\widgets\ActiveForm;
 use yii\captcha\Captcha;
 
-/**
- * @var yii\web\View $this
- * @var yii\widgets\ActiveForm $form
- * @var \frontend\models\ContactForm $model
- */
+/* @var $this yii\web\View */
+/* @var $form yii\widgets\ActiveForm */
+/* @var $model \frontend\models\ContactForm */
+
 $this->title = 'Contact';
 $this->params['breadcrumbs'][] = $this->title;
 ?>

diff --git a/apps/advanced/frontend/views/site/error.php b/apps/advanced/frontend/views/site/error.php
@@ -2,12 +2,10 @@
 
 use yii\helpers\Html;
 
-/**
- * @var yii\web\View $this
- * @var string $name
- * @var string $message
- * @var Exception $exception
- */
+/* @var $this yii\web\View */
+/* @var $name string */
+/* @var $message string */
+/* @var $exception Exception */
 
 $this->title = $name;
 ?>

diff --git a/apps/advanced/frontend/views/site/index.php b/apps/advanced/frontend/views/site/index.php
@@ -1,7 +1,5 @@
 <?php
-/**
- * @var yii\web\View $this
- */
+/* @var $this yii\web\View */
 $this->title = 'My Yii Application';
 ?>
 <div class="site-index">

diff --git a/apps/advanced/frontend/views/site/login.php b/apps/advanced/frontend/views/site/login.php
@@ -2,11 +2,10 @@
 use yii\helpers\Html;
 use yii\widgets\ActiveForm;
 
-/**
- * @var yii\web\View $this
- * @var yii\widgets\ActiveForm $form
- * @var \common\models\LoginForm $model
- */
+/* @var $this yii\web\View */
+/* @var $form yii\widgets\ActiveForm */
+/* @var $model \common\models\LoginForm */
+
 $this->title = 'Login';
 $this->params['breadcrumbs'][] = $this->title;
 ?>

diff --git a/apps/advanced/frontend/views/site/requestPasswordResetToken.php b/apps/advanced/frontend/views/site/requestPasswordResetToken.php
@@ -2,11 +2,10 @@
 use yii\helpers\Html;
 use yii\widgets\ActiveForm;
 
-/**
- * @var yii\web\View $this
- * @var yii\widgets\ActiveForm $form
- * @var \frontend\models\PasswordResetRequestForm $model
- */
+/* @var $this yii\web\View */
+/* @var $form yii\widgets\ActiveForm */
+/* @var $model \frontend\models\PasswordResetRequestForm */
+
 $this->title = 'Request password reset';
 $this->params['breadcrumbs'][] = $this->title;
 ?>

diff --git a/apps/advanced/frontend/views/site/resetPassword.php b/apps/advanced/frontend/views/site/resetPassword.php
@@ -2,11 +2,10 @@
 use yii\helpers\Html;
 use yii\widgets\ActiveForm;
 
-/**
- * @var yii\web\View $this
- * @var yii\widgets\ActiveForm $form
- * @var \frontend\models\ResetPasswordForm $model
- */
+/* @var $this yii\web\View */
+/* @var $form yii\widgets\ActiveForm */
+/* @var $model \frontend\models\ResetPasswordForm */
+
 $this->title = 'Reset password';
 $this->params['breadcrumbs'][] = $this->title;
 ?>

diff --git a/apps/advanced/frontend/views/site/signup.php b/apps/advanced/frontend/views/site/signup.php
@@ -2,11 +2,10 @@
 use yii\helpers\Html;
 use yii\widgets\ActiveForm;
 
-/**
- * @var yii\web\View $this
- * @var yii\widgets\ActiveForm $form
- * @var \frontend\models\SignupForm $model
- */
+/* @var $this yii\web\View */
+/* @var $form yii\widgets\ActiveForm */
+/* @var $model \frontend\models\SignupForm */
+
 $this->title = 'Signup';
 $this->params['breadcrumbs'][] = $this->title;
 ?>

diff --git a/apps/basic/mail/layouts/html.php b/apps/basic/mail/layouts/html.php
@@ -1,10 +1,9 @@
 <?php
 use yii\helpers\Html;
 
-/**
- * @var \yii\web\View $this
- * @var string $content
- */
+/* @var $this \yii\web\View */
+/* @var $content string */
+
 ?>
 <?php $this->beginPage() ?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

diff --git a/apps/basic/views/layouts/main.php b/apps/basic/views/layouts/main.php
@@ -5,10 +5,9 @@
 use yii\widgets\Breadcrumbs;
 use app\assets\AppAsset;
 
-/**
- * @var \yii\web\View $this
- * @var string $content
- */
+/* @var $this \yii\web\View */
+/* @var $content string */
+
 AppAsset::register($this);
 ?>
 <?php $this->beginPage() ?>

diff --git a/apps/basic/views/site/about.php b/apps/basic/views/site/about.php
@@ -1,9 +1,7 @@
 <?php
 use yii\helpers\Html;
 
-/**
- * @var yii\web\View $this
- */
+/* @var $this yii\web\View */
 $this->title = 'About';
 $this->params['breadcrumbs'][] = $this->title;
 ?>

diff --git a/apps/basic/views/site/contact.php b/apps/basic/views/site/contact.php
@@ -3,11 +3,10 @@
 use yii\widgets\ActiveForm;
 use yii\captcha\Captcha;
 
-/**
- * @var yii\web\View $this
- * @var yii\widgets\ActiveForm $form
- * @var app\models\ContactForm $model
- */
+/* @var $this yii\web\View */
+/* @var $form yii\widgets\ActiveForm */
+/* @var $model app\models\ContactForm */
+
 $this->title = 'Contact';
 $this->params['breadcrumbs'][] = $this->title;
 ?>

diff --git a/apps/basic/views/site/error.php b/apps/basic/views/site/error.php
@@ -2,12 +2,10 @@
 
 use yii\helpers\Html;
 
-/**
- * @var yii\web\View $this
- * @var string $name
- * @var string $message
- * @var Exception $exception
- */
+/* @var $this yii\web\View */
+/* @var $name string */
+/* @var $message string */
+/* @var $exception Exception */
 
 $this->title = $name;
 ?>

diff --git a/apps/basic/views/site/index.php b/apps/basic/views/site/index.php
@@ -1,7 +1,5 @@
 <?php
-/**
- * @var yii\web\View $this
- */
+/* @var $this yii\web\View */
 $this->title = 'My Yii Application';
 ?>
 <div class="site-index">

diff --git a/apps/basic/views/site/login.php b/apps/basic/views/site/login.php
@@ -2,11 +2,10 @@
 use yii\helpers\Html;
 use yii\widgets\ActiveForm;
 
-/**
- * @var yii\web\View $this
- * @var yii\widgets\ActiveForm $form
- * @var app\models\LoginForm $model
- */
+/* @var $this yii\web\View */
+/* @var $form yii\widgets\ActiveForm */
+/* @var $model app\models\LoginForm */
+
 $this->title = 'Login';
 $this->params['breadcrumbs'][] = $this->title;
 ?>

diff --git a/build/controllers/TranslationController.php b/build/controllers/TranslationController.php
@@ -40,7 +40,7 @@ public function actionReport($sourcePath, $translationPath, $title = 'Translatio
 
  $dir = new DirectoryIterator($sourcePath);
  foreach ($dir as $fileinfo) {
- /** @var DirectoryIterator $fileinfo */
+ /* @var $fileinfo DirectoryIterator */
  if (!$fileinfo->isDot() && !$fileinfo->isDir()) {
  $translatedFilePath = $translationPath . '/' . $fileinfo->getFilename();
  $sourceFilePath = $sourcePath . '/' . $fileinfo->getFilename();
@@ -63,7 +63,7 @@ public function actionReport($sourcePath, $translationPath, $title = 'Translatio
  // checking if there are obsolete translation files
  $dir = new DirectoryIterator($translationPath);
  foreach ($dir as $fileinfo) {
- /** @var \DirectoryIterator $fileinfo */
+ /* @var $fileinfo \DirectoryIterator */
  if (!$fileinfo->isDot() && !$fileinfo->isDir()) {
  $translatedFilePath = $translationPath . '/' . $fileinfo->getFilename();
 

diff --git a/docs/guide/structure-views.md b/docs/guide/structure-views.md
@@ -20,11 +20,10 @@ page title and the form, while HTML code organizes them into a presentable HTML
 use yii\helpers\Html;
 use yii\widgets\ActiveForm;
 
-/**
- * @var yii\web\View $this
- * @var yii\widgets\ActiveForm $form
- * @var app\models\LoginForm $model
- */
+/* @var $this yii\web\View */
+/* @var $form yii\widgets\ActiveForm */
+/* @var $model app\models\LoginForm */
+
 $this->title = 'Login';
 ?>
 <h1><?= Html::encode($this->title) ?></h1>
@@ -323,10 +322,9 @@ the code in the layout. In practice, you may want to add more content to it, suc
 ```php
 <?php
 use yii\helpers\Html;
-/**
- * @var yii\web\View $this
- * @var string $content
- */
+
+/* @var $this yii\web\View */
+/* @var $content string */
 ?>
 <?php $this->beginPage() ?>
 <!DOCTYPE html>

diff --git a/docs/guide/tutorial-mailing.md b/docs/guide/tutorial-mailing.md
@@ -92,10 +92,10 @@ Example mail view file content:
 use yii\helpers\Html;
 use yii\helpers\Url;
 
-/**
- * @var \yii\web\View $this view component instance
- * @var \yii\mail\BaseMessage $message instance of newly created mail message
- */
+
+/* @var $this \yii\web\View view component instance */
+/* @var $message \yii\mail\BaseMessage instance of newly created mail message */
+
 ?>
 <h2>This message allows you to visit out site home page by one click</h2>
 <?= Html::a('Go to home page', Url::home('http')) ?>
@@ -140,10 +140,8 @@ Layout can be used to setup mail CSS styles or other shared content:
 <?php
 use yii\helpers\Html;
 
-/**
- * @var \yii\web\View $this view component instance
- * @var string $content main view render result
- */
+/* @var $this \yii\web\View view component instance */
+/* @var $content string main view render result */
 ?>
 <?php $this->beginPage() ?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">