Mirrors/yii
2
0
Fork 0
mirror of https://github.com/yiisoft/yii.git synced 2026-03-03 06:44:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fixes #3115: Updated phpdoc for better code completion in modern IDEs

Browse Source
This commit is contained in:
Alexander Makarov
2013-12-31 12:12:09 +01:00
parent 9a60b594cf
commit dcec697c06
7 changed files with 53 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
framework/web/CClientScript.php
View File

@@ -554,7 +554,7 @@ class CClientScript extends CApplicationComponent
* Registers a script package that is listed in {@link packages}.
* This method is the same as {@link registerCoreScript}.
* @param string $name the name of the script package.
* @return CClientScript the CClientScript object itself (to support method chaining, available since version 1.1.5).
* @return static the CClientScript object itself (to support method chaining, available since version 1.1.5).
* @since 1.1.7
* @see renderCoreScript
*/
@@ -566,7 +566,7 @@ class CClientScript extends CApplicationComponent
/**
* Registers a script package that is listed in {@link packages}.
* @param string $name the name of the script package.
* @return CClientScript the CClientScript object itself (to support method chaining, available since version 1.1.5).
* @return static the CClientScript object itself (to support method chaining, available since version 1.1.5).
* @see renderCoreScript
*/
public function registerCoreScript($name)
@@ -601,7 +601,7 @@ class CClientScript extends CApplicationComponent
* Registers a CSS file
* @param string $url URL of the CSS file
* @param string $media media that the CSS file should be applied to. If empty, it means all media types.
* @return CClientScript the CClientScript object itself (to support method chaining, available since version 1.1.5).
* @return static the CClientScript object itself (to support method chaining, available since version 1.1.5).
*/
public function registerCssFile($url,$media='')
{
@@ -617,7 +617,7 @@ class CClientScript extends CApplicationComponent
* @param string $id ID that uniquely identifies this piece of CSS code
* @param string $css the CSS code
* @param string $media media that the CSS code should be applied to. If empty, it means all media types.
* @return CClientScript the CClientScript object itself (to support method chaining, available since version 1.1.5).
* @return static the CClientScript object itself (to support method chaining, available since version 1.1.5).
*/
public function registerCss($id,$css,$media='')
{
@@ -638,7 +638,7 @@ class CClientScript extends CApplicationComponent
* <li>CClientScript::POS_END : the script is inserted at the end of the body section.</li>
* </ul>
* @param array $htmlOptions additional HTML attributes
* @return CClientScript the CClientScript object itself (to support method chaining, available since version 1.1.5).
* @return static the CClientScript object itself (to support method chaining, available since version 1.1.5).
*/
public function registerScriptFile($url,$position=null,array $htmlOptions=array())
{
@@ -672,7 +672,7 @@ class CClientScript extends CApplicationComponent
* </ul>
* @param array $htmlOptions additional HTML attributes
* Note: HTML attributes are not allowed for script positions "CClientScript::POS_LOAD" and "CClientScript::POS_READY".
* @return CClientScript the CClientScript object itself (to support method chaining, available since version 1.1.5).
* @return static the CClientScript object itself (to support method chaining, available since version 1.1.5).
*/
public function registerScript($id,$script,$position=null,array $htmlOptions=array())
{
@@ -712,7 +712,7 @@ class CClientScript extends CApplicationComponent
* @param string $httpEquiv http-equiv attribute of the meta tag. If null, the attribute will not be generated
* @param array $options other options in name-value pairs (e.g. 'scheme', 'lang')
* @param string $id Optional id of the meta tag to avoid duplicates
* @return CClientScript the CClientScript object itself (to support method chaining, available since version 1.1.5).
* @return static the CClientScript object itself (to support method chaining, available since version 1.1.5).
*/
public function registerMetaTag($content,$name=null,$httpEquiv=null,$options=array(),$id=null)
{
@@ -735,7 +735,7 @@ class CClientScript extends CApplicationComponent
* @param string $href href attribute of the link tag. If null, the attribute will not be generated.
* @param string $media media attribute of the link tag. If null, the attribute will not be generated.
* @param array $options other options in name-value pairs
* @return CClientScript the CClientScript object itself (to support method chaining, available since version 1.1.5).
* @return static the CClientScript object itself (to support method chaining, available since version 1.1.5).
*/
public function registerLinkTag($relation=null,$type=null,$href=null,$media=null,$options=array())
{
@@ -830,7 +830,7 @@ class CClientScript extends CApplicationComponent
* @param string $name the name of the script package.
* @param array $definition the definition array of the script package,
* @see CClientScript::packages.
* @return CClientScript the CClientScript object itself (to support method chaining, available since version 1.1.10).
* @return static the CClientScript object itself (to support method chaining, available since version 1.1.10).
*
* @since 1.1.9
*/