mirror of
https://github.com/yiisoft/yii2.git
synced 2025-08-26 14:26:54 +08:00
doc cleanup.
This commit is contained in:
@ -13,7 +13,7 @@ namespace yii\caching;
|
||||
* To use this application component, the [WinCache PHP extension](http://www.iis.net/expand/wincacheforphp)
|
||||
* must be loaded. Also note that "wincache.ucenabled" should be set to "On" in your php.ini file.
|
||||
*
|
||||
* See {@link CCache} manual for common cache operations that are supported by WinCache.
|
||||
* See [[Cache]] manual for common cache operations that are supported by WinCache.
|
||||
*
|
||||
* @author Qiang Xue <qiang.xue@gmail.com>
|
||||
* @since 2.0
|
||||
|
@ -312,7 +312,7 @@ class Migration extends \yii\base\Component
|
||||
* Builds and executes 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'.
|
||||
*/
|
||||
|
@ -44,7 +44,7 @@ class CheckboxColumn extends Column
|
||||
|
||||
/**
|
||||
* Renders the header cell content.
|
||||
* The default implementation simply renders {@link header}.
|
||||
* The default implementation simply renders [[header]].
|
||||
* This method may be overridden to customize the rendering of the header cell.
|
||||
* @return string the rendering result
|
||||
*/
|
||||
|
@ -94,7 +94,7 @@ class Column extends Object
|
||||
|
||||
/**
|
||||
* Renders the header cell content.
|
||||
* The default implementation simply renders {@link header}.
|
||||
* The default implementation simply renders [[header]].
|
||||
* This method may be overridden to customize the rendering of the header cell.
|
||||
* @return string the rendering result
|
||||
*/
|
||||
@ -105,7 +105,7 @@ class Column extends Object
|
||||
|
||||
/**
|
||||
* Renders the footer cell content.
|
||||
* The default implementation simply renders {@link footer}.
|
||||
* The default implementation simply renders [[footer]].
|
||||
* This method may be overridden to customize the rendering of the footer cell.
|
||||
* @return string the rendering result
|
||||
*/
|
||||
|
@ -162,7 +162,7 @@ class GridView extends BaseListView
|
||||
|
||||
/**
|
||||
* Initializes the grid view.
|
||||
* This method will initialize required property values and instantiate {@link columns} objects.
|
||||
* This method will initialize required property values and instantiate [[columns]] objects.
|
||||
*/
|
||||
public function init()
|
||||
{
|
||||
|
@ -142,7 +142,7 @@ class BaseConsole
|
||||
|
||||
/**
|
||||
* Saves the current cursor position by sending ANSI control code SCP to the terminal.
|
||||
* Position can then be restored with {@link restoreCursorPosition}.
|
||||
* Position can then be restored with [[restoreCursorPosition()]].
|
||||
*/
|
||||
public static function saveCursorPosition()
|
||||
{
|
||||
@ -150,7 +150,7 @@ class BaseConsole
|
||||
}
|
||||
|
||||
/**
|
||||
* Restores the cursor position saved with {@link saveCursorPosition} by sending ANSI control code RCP to the terminal.
|
||||
* Restores the cursor position saved with [[saveCursorPosition()]] by sending ANSI control code RCP to the terminal.
|
||||
*/
|
||||
public static function restoreCursorPosition()
|
||||
{
|
||||
@ -159,7 +159,7 @@ class BaseConsole
|
||||
|
||||
/**
|
||||
* Hides the cursor by sending ANSI DECTCEM code ?25l to the terminal.
|
||||
* Use {@link showCursor} to bring it back.
|
||||
* Use [[showCursor()]] to bring it back.
|
||||
* Do not forget to show cursor when your application exits. Cursor might stay hidden in terminal after exit.
|
||||
*/
|
||||
public static function hideCursor()
|
||||
@ -168,7 +168,7 @@ class BaseConsole
|
||||
}
|
||||
|
||||
/**
|
||||
* Will show a cursor again when it has been hidden by {@link hideCursor} by sending ANSI DECTCEM code ?25h to the terminal.
|
||||
* Will show a cursor again when it has been hidden by [[hideCursor()]] by sending ANSI DECTCEM code ?25h to the terminal.
|
||||
*/
|
||||
public static function showCursor()
|
||||
{
|
||||
|
@ -94,7 +94,7 @@ class FragmentCache extends Widget
|
||||
|
||||
/**
|
||||
* Marks the end of content to be cached.
|
||||
* Content displayed before this method call and after {@link init()}
|
||||
* Content displayed before this method call and after [[init()]]
|
||||
* will be captured and saved in cache.
|
||||
* This method does nothing if valid content is already found in cache.
|
||||
*/
|
||||
|
@ -108,7 +108,7 @@ class MessageControllerTest extends TestCase
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates message command config file at {@link configFileName}
|
||||
* Creates message command config file named as [[configFileName]].
|
||||
* @param array $config message command config.
|
||||
*/
|
||||
protected function composeConfigFile(array $config)
|
||||
|
Reference in New Issue
Block a user