diff --git a/extensions/authclient/AuthAction.php b/extensions/authclient/AuthAction.php index 77f4b75..1144bd4 100644 --- a/extensions/authclient/AuthAction.php +++ b/extensions/authclient/AuthAction.php @@ -18,9 +18,10 @@ use Yii; /** * AuthAction performs authentication via different auth clients. - * It supports [[OpenId]], [[OAuth1] and [[OAuth2]] client types. + * It supports [[OpenId]], [[OAuth1]] and [[OAuth2]] client types. * * Usage: + * * ~~~ * class SiteController extends Controller * { @@ -139,7 +140,7 @@ class AuthAction extends Action } /** - * Creates default {@link successUrl} value. + * Creates default [[successUrl]] value. * @return string success URL value. */ protected function defaultSuccessUrl() @@ -148,7 +149,7 @@ class AuthAction extends Action } /** - * Creates default {@link cancelUrl} value. + * Creates default [[cancelUrl]] value. * @return string cancel URL value. */ protected function defaultCancelUrl() @@ -236,7 +237,7 @@ class AuthAction extends Action } /** - * Redirect to the URL. If URL is null, {@link successUrl} will be used. + * Redirect to the URL. If URL is null, [[successUrl]] will be used. * @param string $url URL to redirect. * @return \yii\web\Response response instance. */ @@ -249,7 +250,7 @@ class AuthAction extends Action } /** - * Redirect to the {@link cancelUrl} or simply close the popup window. + * Redirect to the [[cancelUrl]] or simply close the popup window. * @param string $url URL to redirect. * @return \yii\web\Response response instance. */ diff --git a/extensions/authclient/BaseClient.php b/extensions/authclient/BaseClient.php index 857fa43..e11c10d 100644 --- a/extensions/authclient/BaseClient.php +++ b/extensions/authclient/BaseClient.php @@ -226,7 +226,7 @@ abstract class BaseClient extends Component implements ClientInterface } /** - * Normalize given user attributes according to {@link normalizeUserAttributeMap}. + * Normalize given user attributes according to [[normalizeUserAttributeMap]]. * @param array $attributes raw attributes. * @return array normalized attributes. */ diff --git a/extensions/authclient/BaseOAuth.php b/extensions/authclient/BaseOAuth.php index ce597b3..aa82d7f 100644 --- a/extensions/authclient/BaseOAuth.php +++ b/extensions/authclient/BaseOAuth.php @@ -58,7 +58,7 @@ abstract class BaseOAuth extends BaseClient implements ClientInterface public $scope; /** * @var array cURL request options. Option values from this field will overwrite corresponding - * values from {@link defaultCurlOptions()}. + * values from [[defaultCurlOptions()]]. */ private $_curlOptions = []; /** @@ -155,7 +155,7 @@ abstract class BaseOAuth extends BaseClient implements ClientInterface } /** - * Composes default {@link returnUrl} value. + * Composes default [[returnUrl]] value. * @return string return URL. */ protected function defaultReturnUrl() diff --git a/extensions/authclient/OAuth1.php b/extensions/authclient/OAuth1.php index a6a44a8..eea790c 100644 --- a/extensions/authclient/OAuth1.php +++ b/extensions/authclient/OAuth1.php @@ -147,7 +147,7 @@ class OAuth1 extends BaseOAuth } /** - * Sends HTTP request, signed by {@link signatureMethod}. + * Sends HTTP request, signed by [[signatureMethod]]. * @param string $method request type. * @param string $url request URL. * @param array $params request params. @@ -235,7 +235,7 @@ class OAuth1 extends BaseOAuth } /** - * Composes default {@link returnUrl} value. + * Composes default [[returnUrl]] value. * @return string return URL. */ protected function defaultReturnUrl() @@ -281,7 +281,7 @@ class OAuth1 extends BaseOAuth } /** - * Sign request with {@link signatureMethod}. + * Sign request with [[signatureMethod]]. * @param string $method request method. * @param string $url request URL. * @param array $params request params. @@ -299,7 +299,7 @@ class OAuth1 extends BaseOAuth } /** - * Creates signature base string, which will be signed by {@link signatureMethod}. + * Creates signature base string, which will be signed by [[signatureMethod]]. * @param string $method request method. * @param string $url request URL. * @param array $params request params. diff --git a/extensions/authclient/OAuth2.php b/extensions/authclient/OAuth2.php index 3f8d7b8..35a7e78 100644 --- a/extensions/authclient/OAuth2.php +++ b/extensions/authclient/OAuth2.php @@ -166,7 +166,7 @@ class OAuth2 extends BaseOAuth } /** - * Composes default {@link returnUrl} value. + * Composes default [[returnUrl]] value. * @return string return URL. */ protected function defaultReturnUrl() diff --git a/extensions/authclient/OAuthToken.php b/extensions/authclient/OAuthToken.php index a1562d1..2c35225 100644 --- a/extensions/authclient/OAuthToken.php +++ b/extensions/authclient/OAuthToken.php @@ -27,15 +27,15 @@ use yii\base\Object; class OAuthToken extends Object { /** - * @var string key in {@link _params} array, which stores token key. + * @var string key in [[params]] array, which stores token key. */ public $tokenParamKey = 'oauth_token'; /** - * @var string key in {@link _params} array, which stores token secret key. + * @var string key in [[params]] array, which stores token secret key. */ public $tokenSecretParamKey = 'oauth_token_secret'; /** - * @var string key in {@link _params} array, which stores token expiration duration. + * @var string key in [[params]] array, which stores token expiration duration. * If not set will attempt to fetch its value automatically. */ private $_expireDurationParamKey; diff --git a/extensions/authclient/signature/HmacSha1.php b/extensions/authclient/signature/HmacSha1.php index 1e20bf9..408e0b0 100644 --- a/extensions/authclient/signature/HmacSha1.php +++ b/extensions/authclient/signature/HmacSha1.php @@ -12,7 +12,7 @@ use yii\base\NotSupportedException; /** * HmacSha1 represents 'HMAC-SHA1' signature method. * - * Note: This class require PHP "Hash" extension({@link http://php.net/manual/en/book.hash.php}). + * > **Note:** This class requires PHP "Hash" extension(<http://php.net/manual/en/book.hash.php>). * * @author Paul Klimov <klimov.paul@gmail.com> * @since 2.0 diff --git a/extensions/authclient/signature/RsaSha1.php b/extensions/authclient/signature/RsaSha1.php index 5d11a42..b17af0f 100644 --- a/extensions/authclient/signature/RsaSha1.php +++ b/extensions/authclient/signature/RsaSha1.php @@ -13,7 +13,7 @@ use yii\base\NotSupportedException; /** * RsaSha1 represents 'RSA-SHA1' signature method. * - * Note: This class require PHP "OpenSSL" extension({@link http://php.net/manual/en/book.openssl.php}). + * > **Note:** This class requires PHP "OpenSSL" extension(<http://php.net/manual/en/book.openssl.php>). * * @property string $privateCertificate Private key certificate content. * @property string $publicCertificate Public key certificate content. @@ -25,12 +25,12 @@ class RsaSha1 extends BaseMethod { /** * @var string OpenSSL private key certificate content. - * This value can be fetched from file specified by {@link privateCertificateFile}. + * This value can be fetched from file specified by [[privateCertificateFile]]. */ protected $_privateCertificate; /** * @var string OpenSSL public key certificate content. - * This value can be fetched from file specified by {@link publicCertificateFile}. + * This value can be fetched from file specified by [[publicCertificateFile]]. */ protected $_publicCertificate; /** @@ -101,8 +101,8 @@ class RsaSha1 extends BaseMethod } /** - * Creates initial value for {@link publicCertificate}. - * This method will attempt to fetch the certificate value from {@link publicCertificateFile} file. + * Creates initial value for [[publicCertificate]]. + * This method will attempt to fetch the certificate value from [[publicCertificateFile]] file. * @throws InvalidConfigException on failure. * @return string public certificate content. */ @@ -120,8 +120,8 @@ class RsaSha1 extends BaseMethod } /** - * Creates initial value for {@link privateCertificate}. - * This method will attempt to fetch the certificate value from {@link privateCertificateFile} file. + * Creates initial value for [[privateCertificate]]. + * This method will attempt to fetch the certificate value from [[privateCertificateFile]] file. * @throws InvalidConfigException on failure. * @return string private certificate content. */ diff --git a/extensions/authclient/widgets/AuthChoice.php b/extensions/authclient/widgets/AuthChoice.php index d6f152a..7db1f6e 100644 --- a/extensions/authclient/widgets/AuthChoice.php +++ b/extensions/authclient/widgets/AuthChoice.php @@ -28,7 +28,7 @@ use yii\authclient\ClientInterface; * ~~~ * * You can customize the widget appearance by using [[begin()]] and [[end()]] syntax - * along with using method {@link clientLink()} or {@link createClientUrl()}. + * along with using method [[clientLink()]] or [[createClientUrl()]]. * For example: * * ~~~php diff --git a/framework/db/mssql/QueryBuilder.php b/framework/db/mssql/QueryBuilder.php index 8a8fece..448235e 100644 --- a/framework/db/mssql/QueryBuilder.php +++ b/framework/db/mssql/QueryBuilder.php @@ -103,7 +103,7 @@ class QueryBuilder extends \yii\db\QueryBuilder * Builds a SQL statement for changing the definition of a column. * @param string $table the table whose column is to be changed. The table name will be properly quoted by the method. * @param string $column the name of the column to be changed. The name will be properly quoted by the method. - * @param string $type the new column type. The {@link getColumnType} method will be invoked to convert abstract column type (if any) + * @param string $type the new column type. The [[getColumnType]] method will be invoked to convert abstract column type (if any) * into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. * For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'. * @return string the SQL statement for changing the definition of a column. diff --git a/framework/db/oci/QueryBuilder.php b/framework/db/oci/QueryBuilder.php index a33ad5d..1119cd3 100644 --- a/framework/db/oci/QueryBuilder.php +++ b/framework/db/oci/QueryBuilder.php @@ -92,7 +92,7 @@ EOD; * * @param string $table the table whose column is to be changed. The table name will be properly quoted by the method. * @param string $column the name of the column to be changed. The name will be properly quoted by the method. - * @param string $type the new column type. The {@link getColumnType} method will be invoked to convert abstract column type (if any) + * @param string $type the new column type. The [[getColumnType]] method will be invoked to convert abstract column type (if any) * into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. * For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'. * @return string the SQL statement for changing the definition of a column.