Browse Source

updated phpdoc

tags/2.0.0-rc
Carsten Brandt 11 years ago
parent
commit
c27ac8ef0e
  1. 4
      build/controllers/PhpDocController.php
  2. 3
      extensions/authclient/BaseOAuth.php
  3. 2
      extensions/authclient/OAuthToken.php
  4. 1
      extensions/elasticsearch/Connection.php
  5. 2
      extensions/sphinx/Query.php
  6. 4
      framework/base/Controller.php
  7. 3
      framework/rbac/PhpManager.php

4
build/controllers/PhpDocController.php

@ -22,13 +22,13 @@ use yii\helpers\FileHelper;
class PhpDocController extends Controller
{
public $defaultAction = 'property';
/**
* @var boolean whether to update class docs directly. Setting this to false will just output docs
* for copy and paste.
*/
public $updateFiles = true;
/**
* Generates `@property` annotations in class files from getters and setters
*
@ -125,6 +125,7 @@ class PhpDocController extends Controller
'/build/',
'/docs/',
'/extensions/apidoc/helpers/PrettyPrinter.php',
'/extensions/apidoc/helpers/ApiIndexer.php',
'/extensions/codeception/TestCase.php',
'/extensions/codeception/DbTestCase.php',
'/extensions/composer/',
@ -133,6 +134,7 @@ class PhpDocController extends Controller
'/extensions/twig/TwigSimpleFileLoader.php',
'/framework/BaseYii.php',
'/framework/Yii.php',
'assets/',
'tests/',
'vendor/',
];

3
extensions/authclient/BaseOAuth.php

@ -21,7 +21,8 @@ use yii\helpers\Json;
* getter and setter. See [[getAccessToken()]] and [[setAccessToken()]] for details.
* @property array $curlOptions CURL options. This property is read-only.
* @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>
* @since 2.0

2
extensions/authclient/OAuthToken.php

@ -18,7 +18,7 @@ use yii\base\Object;
* @property boolean $isExpired Is token expired. 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 string $token Token value. This property is read-only.
* @property string $token Token value.
* @property string $tokenSecret Token secret value.
*
* @author Paul Klimov <klimov.paul@gmail.com>

1
extensions/elasticsearch/Connection.php

@ -17,6 +17,7 @@ use yii\helpers\Json;
*
* @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 QueryBuilder $queryBuilder This property is read-only.
*
* @author Carsten Brandt <mail@cebe.cc>
* @since 2.0

2
extensions/sphinx/Query.php

@ -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!
*
* @property Connection $connection Sphinx connection instance. This property is read-only.
* @property Connection $connection Sphinx connection instance.
*
* @author Paul Klimov <klimov.paul@gmail.com>
* @since 2.0

4
framework/base/Controller.php

@ -18,7 +18,7 @@ use Yii;
* property is read-only.
* @property string $uniqueId The controller ID that is prefixed with the module ID (if any). This property is
* 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
* read-only.
*
@ -410,7 +410,7 @@ class Controller extends Component implements ViewContextInterface
/**
* 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)
{

3
framework/rbac/PhpManager.php

@ -22,9 +22,6 @@ use Yii;
* (for example, the authorization data for a personal blog system).
* 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 Alexander Kochetov <creocoder@gmail.com>
* @author Christophe Boulain <christophe.boulain@gmail.com>

Loading…
Cancel
Save