Commit c27ac8ef by Carsten Brandt

updated phpdoc

parent 3c3ea398
...@@ -22,13 +22,13 @@ use yii\helpers\FileHelper; ...@@ -22,13 +22,13 @@ use yii\helpers\FileHelper;
class PhpDocController extends Controller class PhpDocController extends Controller
{ {
public $defaultAction = 'property'; public $defaultAction = 'property';
/** /**
* @var boolean whether to update class docs directly. Setting this to false will just output docs * @var boolean whether to update class docs directly. Setting this to false will just output docs
* for copy and paste. * for copy and paste.
*/ */
public $updateFiles = true; public $updateFiles = true;
/** /**
* Generates `@property` annotations in class files from getters and setters * Generates `@property` annotations in class files from getters and setters
* *
...@@ -125,6 +125,7 @@ class PhpDocController extends Controller ...@@ -125,6 +125,7 @@ class PhpDocController extends Controller
'/build/', '/build/',
'/docs/', '/docs/',
'/extensions/apidoc/helpers/PrettyPrinter.php', '/extensions/apidoc/helpers/PrettyPrinter.php',
'/extensions/apidoc/helpers/ApiIndexer.php',
'/extensions/codeception/TestCase.php', '/extensions/codeception/TestCase.php',
'/extensions/codeception/DbTestCase.php', '/extensions/codeception/DbTestCase.php',
'/extensions/composer/', '/extensions/composer/',
...@@ -133,6 +134,7 @@ class PhpDocController extends Controller ...@@ -133,6 +134,7 @@ class PhpDocController extends Controller
'/extensions/twig/TwigSimpleFileLoader.php', '/extensions/twig/TwigSimpleFileLoader.php',
'/framework/BaseYii.php', '/framework/BaseYii.php',
'/framework/Yii.php', '/framework/Yii.php',
'assets/',
'tests/', 'tests/',
'vendor/', 'vendor/',
]; ];
......
...@@ -21,7 +21,8 @@ use yii\helpers\Json; ...@@ -21,7 +21,8 @@ use yii\helpers\Json;
* getter and setter. See [[getAccessToken()]] and [[setAccessToken()]] for details. * getter and setter. See [[getAccessToken()]] and [[setAccessToken()]] for details.
* @property array $curlOptions CURL options. This property is read-only. * @property array $curlOptions CURL options. This property is read-only.
* @property string $returnUrl Return URL. * @property string $returnUrl Return URL.
* @property signature\BaseMethod $signatureMethod Signature method instance. This property is read-only. * @property signature\BaseMethod $signatureMethod Signature method instance. Note that the type of this
* property differs in getter and setter. See [[getSignatureMethod()]] and [[setSignatureMethod()]] for details.
* *
* @author Paul Klimov <klimov.paul@gmail.com> * @author Paul Klimov <klimov.paul@gmail.com>
* @since 2.0 * @since 2.0
......
...@@ -18,7 +18,7 @@ use yii\base\Object; ...@@ -18,7 +18,7 @@ use yii\base\Object;
* @property boolean $isExpired Is token expired. This property is read-only. * @property boolean $isExpired Is token expired. This property is read-only.
* @property boolean $isValid Is token valid. This property is read-only. * @property boolean $isValid Is token valid. This property is read-only.
* @property array $params This property is read-only. * @property array $params This property is read-only.
* @property string $token Token value. This property is read-only. * @property string $token Token value.
* @property string $tokenSecret Token secret value. * @property string $tokenSecret Token secret value.
* *
* @author Paul Klimov <klimov.paul@gmail.com> * @author Paul Klimov <klimov.paul@gmail.com>
......
...@@ -17,6 +17,7 @@ use yii\helpers\Json; ...@@ -17,6 +17,7 @@ use yii\helpers\Json;
* *
* @property string $driverName Name of the DB driver. This property is read-only. * @property string $driverName Name of the DB driver. This property is read-only.
* @property boolean $isActive Whether the DB connection is established. This property is read-only. * @property boolean $isActive Whether the DB connection is established. This property is read-only.
* @property QueryBuilder $queryBuilder This property is read-only.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0
......
...@@ -41,7 +41,7 @@ use yii\db\QueryTrait; ...@@ -41,7 +41,7 @@ use yii\db\QueryTrait;
* *
* Warning: even if you do not set any query limit, implicit LIMIT 0,20 is present by default! * Warning: even if you do not set any query limit, implicit LIMIT 0,20 is present by default!
* *
* @property Connection $connection Sphinx connection instance. This property is read-only. * @property Connection $connection Sphinx connection instance.
* *
* @author Paul Klimov <klimov.paul@gmail.com> * @author Paul Klimov <klimov.paul@gmail.com>
* @since 2.0 * @since 2.0
......
...@@ -18,7 +18,7 @@ use Yii; ...@@ -18,7 +18,7 @@ use Yii;
* property is read-only. * property is read-only.
* @property string $uniqueId The controller ID that is prefixed with the module ID (if any). This property is * @property string $uniqueId The controller ID that is prefixed with the module ID (if any). This property is
* read-only. * read-only.
* @property View $view The view object that can be used to render views or view files. * @property View|\yii\web\View $view The view object that can be used to render views or view files.
* @property string $viewPath The directory containing the view files for this controller. This property is * @property string $viewPath The directory containing the view files for this controller. This property is
* read-only. * read-only.
* *
...@@ -410,7 +410,7 @@ class Controller extends Component implements ViewContextInterface ...@@ -410,7 +410,7 @@ class Controller extends Component implements ViewContextInterface
/** /**
* Sets the view object to be used by this controller. * Sets the view object to be used by this controller.
* @param View $view the view object that can be used to render views or view files. * @param View|\yii\web\View $view the view object that can be used to render views or view files.
*/ */
public function setView($view) public function setView($view)
{ {
......
...@@ -22,9 +22,6 @@ use Yii; ...@@ -22,9 +22,6 @@ use Yii;
* (for example, the authorization data for a personal blog system). * (for example, the authorization data for a personal blog system).
* Use [[DbManager]] for more complex authorization data. * Use [[DbManager]] for more complex authorization data.
* *
* @property Item[] $items The authorization items of the specific type. This property is read-only.
* @property Rule[] $rules This property is read-only.
*
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @author Alexander Kochetov <creocoder@gmail.com> * @author Alexander Kochetov <creocoder@gmail.com>
* @author Christophe Boulain <christophe.boulain@gmail.com> * @author Christophe Boulain <christophe.boulain@gmail.com>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment