Commit 6fff5662 by Carsten Brandt

better use @see for See in phpdoc

parent c94a40e9
......@@ -72,7 +72,7 @@ class Choice extends Widget
public $clientIdGetParamName = 'authclient';
/**
* @var array the HTML attributes that should be rendered in the div HTML tag representing the container element.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [
'class' => 'auth-clients'
......
......@@ -39,7 +39,7 @@ class ButtonDropdown extends Widget
public $label = 'Button';
/**
* @var array the HTML attributes of the button.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
......
......@@ -44,7 +44,7 @@ class NavBar extends Widget
*
* - tag: string, defaults to "nav", the name of the container tag.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
......@@ -52,7 +52,7 @@ class NavBar extends Widget
*
* - tag: string, defaults to "div", the name of the container tag.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $containerOptions = [];
/**
......@@ -67,7 +67,7 @@ class NavBar extends Widget
public $brandUrl;
/**
* @var array the HTML attributes of the brand link.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $brandOptions = [];
/**
......@@ -81,7 +81,7 @@ class NavBar extends Widget
public $renderInnerContainer = true;
/**
* @var array the HTML attributes of the inner container.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $innerContainerOptions = [];
......
......@@ -69,7 +69,7 @@ class Progress extends Widget
public $percent = 0;
/**
* @var array the HTML attributes of the bar.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $barOptions = [];
/**
......
......@@ -76,19 +76,19 @@ class Tabs extends Widget
*
* - tag: string, defaults to "div", the tag name of the item container tags.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $itemOptions = [];
/**
* @var array list of HTML attributes for the header container tags. This will be overwritten
* by the "headerOptions" set in individual [[items]].
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $headerOptions = [];
/**
* @var array list of HTML attributes for the tab header link tags. This will be overwritten
* by the "linkOptions" set in individual [[items]].
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $linkOptions = [];
/**
......
......@@ -21,7 +21,7 @@ class Widget extends \yii\base\Widget
{
/**
* @var array the HTML attributes for the widget container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
......
......@@ -48,7 +48,7 @@ class Accordion extends Widget
*
* - tag: string, defaults to "div", the tag name of the container tag of this widget
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
......@@ -72,7 +72,7 @@ class Accordion extends Widget
*
* - tag: string, defaults to "div", the tag name of the item container tags.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $itemOptions = [];
/**
......@@ -81,7 +81,7 @@ class Accordion extends Widget
*
* - tag: string, defaults to "h3", the tag name of the item container tags.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $headerOptions = [];
......
......@@ -56,7 +56,7 @@ class DatePicker extends InputWidget
public $inline = false;
/**
* @var array the HTML attributes for the container tag. This is only used when [[inline]] is true.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $containerOptions = [];
......
......@@ -53,7 +53,7 @@ class Selectable extends Widget
*
* - tag: string, defaults to "ul", the tag name of the container tag of this widget.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
......@@ -75,7 +75,7 @@ class Selectable extends Widget
*
* - tag: string, defaults to "li", the tag name of the item container tags.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $itemOptions = [];
......
......@@ -55,7 +55,7 @@ class SliderInput extends InputWidget
];
/**
* @var array the HTML attributes for the container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $containerOptions = [];
......
......@@ -43,7 +43,7 @@ class Sortable extends Widget
*
* - tag: string, defaults to "ul", the tag name of the container tag of this widget.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
......@@ -65,7 +65,7 @@ class Sortable extends Widget
*
* - tag: string, defaults to "li", the tag name of the item container tags.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $itemOptions = [];
......
......@@ -58,7 +58,7 @@ class Tabs extends Widget
*
* - tag: string, defaults to "div", the tag name of the container tag of this widget.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
......@@ -80,13 +80,13 @@ class Tabs extends Widget
*
* - tag: string, defaults to "div", the tag name of the item container tags.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $itemOptions = [];
/**
* @var array list of HTML attributes for the header container tags. This will be overwritten
* by the "headerOptions" set in individual [[items]].
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $headerOptions = [];
/**
......
......@@ -24,7 +24,7 @@ class Widget extends \yii\base\Widget
public static $theme = 'yii\jui\ThemeAsset';
/**
* @var array the HTML attributes for the widget container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
......
......@@ -41,7 +41,7 @@ class Captcha extends InputWidget
public $captchaAction = 'site/captcha';
/**
* @var array HTML attributes to be applied to the CAPTCHA image tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $imageOptions = [];
/**
......@@ -52,7 +52,7 @@ class Captcha extends InputWidget
public $template = '{image} {input}';
/**
* @var array the HTML attributes for the input tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = ['class' => 'form-control'];
......
......@@ -19,7 +19,7 @@ use yii\base\InvalidCallException;
/**
* ActiveRecord is the base class for classes representing relational data in terms of objects.
*
* See [[yii\db\ActiveRecord]] for a concrete implementation.
* See [[\yii\db\ActiveRecord]] for a concrete implementation.
*
* @property array $dirtyAttributes The changed attribute values (name-value pairs). This property is
* read-only.
......
......@@ -14,7 +14,7 @@ use yii\helpers\Html;
/**
* CheckboxColumn displays a column of checkboxes in a grid view.
*
* * To add a CheckboxColumn to the [[GridView]], add it to the [[GridView::columns|columns]] configuration as follows:
* To add a CheckboxColumn to the [[GridView]], add it to the [[GridView::columns|columns]] configuration as follows:
*
* ```php
* 'columns' => [
......@@ -45,7 +45,7 @@ class CheckboxColumn extends Column
public $name = 'selection';
/**
* @var array HTML attributes for the checkboxes.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $checkboxOptions = [];
/**
......
......@@ -41,12 +41,12 @@ class Column extends Object
public $visible = true;
/**
* @var array the HTML attributes for the column group tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
* @var array the HTML attributes for the header cell tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $headerOptions = [];
/**
......@@ -55,17 +55,17 @@ class Column extends Object
* The signature of the function should be the following: `function ($model, $key, $index, $gridView)`.
* A function may be used to assign different attributes to different rows based on the data in that row.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $contentOptions = [];
/**
* @var array the HTML attributes for the footer cell tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $footerOptions = [];
/**
* @var array the HTML attributes for the filter cell tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $filterOptions = [];
......
......@@ -62,7 +62,7 @@ class DataColumn extends Column
/**
* @var array the HTML attributes for the link tag in the header cell
* generated by [[\yii\data\Sort::link]] when sorting is enabled for this column.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $sortLinkOptions = [];
/**
......@@ -79,7 +79,7 @@ class DataColumn extends Column
* @var array the HTML attributes for the filter input fields. This property is used in combination with
* the [[filter]] property. When [[filter]] is not set or is an array, this property will be used to
* render the HTML attributes for the generated filter input fields.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $filterInputOptions = ['class' => 'form-control', 'id' => null];
......
......@@ -42,29 +42,29 @@ class GridView extends BaseListView
public $caption;
/**
* @var array the HTML attributes for the caption element.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
* @see caption
*/
public $captionOptions = [];
/**
* @var array the HTML attributes for the grid table element.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $tableOptions = ['class' => 'table table-striped table-bordered'];
/**
* @var array the HTML attributes for the container tag of the grid view.
* The "tag" element specifies the tag name of the container element and defaults to "div".
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = ['class' => 'grid-view'];
/**
* @var array the HTML attributes for the table header row.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $headerRowOptions = [];
/**
* @var array the HTML attributes for the table footer row.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $footerRowOptions = [];
/**
......@@ -82,7 +82,7 @@ class GridView extends BaseListView
* - `$index`: the zero-based index of the data model in the model array returned by [[dataProvider]]
* - `$grid`: the GridView object
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $rowOptions = [];
/**
......@@ -170,7 +170,7 @@ class GridView extends BaseListView
public $filterPosition = self::FILTER_POS_BODY;
/**
* @var array the HTML attributes for the filter row element.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $filterRowOptions = ['class' => 'filters'];
......
......@@ -80,6 +80,7 @@ class BaseHtml
'media',
];
/**
* Encodes special characters into HTML entities.
* The [[\yii\base\Application::charset|application charset]] will be used for encoding.
......
......@@ -41,7 +41,7 @@ class ActiveField extends Component
*
* - tag: the tag name of the container element. Defaults to "div".
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = ['class' => 'form-group'];
/**
......@@ -52,7 +52,7 @@ class ActiveField extends Component
/**
* @var array the default options for the input tags. The parameter passed to individual input methods
* (e.g. [[textInput()]]) will be merged with this property when rendering the input tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $inputOptions = ['class' => 'form-control'];
/**
......@@ -62,13 +62,13 @@ class ActiveField extends Component
*
* - tag: the tag name of the container element. Defaults to "div".
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $errorOptions = ['class' => 'help-block'];
/**
* @var array the default options for the label tags. The parameter passed to [[label()]] will be
* merged with this property when rendering the label tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $labelOptions = ['class' => 'control-label'];
/**
......@@ -78,7 +78,7 @@ class ActiveField extends Component
*
* - tag: the tag name of the container element. Defaults to "div".
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $hintOptions = ['class' => 'hint-block'];
/**
......
......@@ -34,7 +34,7 @@ class ActiveForm extends Widget
public $method = 'post';
/**
* @var array the HTML attributes (name-value pairs) for the form tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
......
......@@ -22,7 +22,7 @@ abstract class BaseListView extends Widget
/**
* @var array the HTML attributes for the container tag of the list view.
* The "tag" element specifies the tag name of the container element and defaults to "div".
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
......
......@@ -53,7 +53,7 @@ class Breadcrumbs extends Widget
public $tag = 'ul';
/**
* @var array the HTML attributes for the breadcrumb container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = ['class' => 'breadcrumb'];
/**
......
......@@ -91,7 +91,7 @@ class DetailView extends Widget
/**
* @var array the HTML attributes for the container tag of this widget. The "tag" option specifies
* what container tag should be used. It defaults to "table" if not set.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = ['class' => 'table table-striped table-bordered detail-view'];
/**
......
......@@ -43,7 +43,7 @@ class InputWidget extends Widget
public $value;
/**
* @var array the HTML attributes for the input tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
......
......@@ -35,12 +35,12 @@ class LinkPager extends Widget
public $pagination;
/**
* @var array HTML attributes for the pager container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = ['class' => 'pagination'];
/**
* @var array HTML attributes for the link in a pager container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $linkOptions = [];
/**
......
......@@ -35,7 +35,7 @@ class LinkSorter extends Widget
/**
* @var array HTML attributes for the sorter container tag.
* @see \yii\helpers\Html::ul() for special attributes.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = ['class' => 'sorter'];
......
......@@ -22,7 +22,7 @@ class ListView extends BaseListView
* @var array the HTML attributes for the container of the rendering result of each data model.
* The "tag" element specifies the tag name of the container element and defaults to "div".
* If "tag" is false, it means no container element will be rendered.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $itemOptions = [];
/**
......@@ -56,7 +56,7 @@ class ListView extends BaseListView
/**
* @var array the HTML attributes for the container tag of the list view.
* The "tag" element specifies the tag name of the container element and defaults to "div".
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = ['class' => 'list-view'];
......
......@@ -63,7 +63,7 @@ class MaskedInput extends InputWidget
public $completed;
/**
* @var array the HTML attributes for the input tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = ['class' => 'form-control'];
......
......@@ -75,7 +75,7 @@ class Menu extends Widget
*
* - tag: string, defaults to "li", the tag name of the item container tags.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $itemOptions = [];
/**
......@@ -125,7 +125,7 @@ class Menu extends Widget
*
* - tag: string, defaults to "ul", the tag name of the item container tags.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
......
......@@ -45,7 +45,7 @@ class Pjax extends Widget
{
/**
* @var array the HTML attributes for the widget container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $options = [];
/**
......
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