Commit eea92429 authored by Carsten Brandt's avatar Carsten Brandt

added a large amount of missing documentation

parent 442be754
...@@ -39,6 +39,7 @@ class ButtonDropdown extends Widget ...@@ -39,6 +39,7 @@ class ButtonDropdown extends Widget
public $label = 'Button'; public $label = 'Button';
/** /**
* @var array the HTML attributes of the button. * @var array the HTML attributes of the button.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
......
...@@ -42,13 +42,17 @@ class NavBar extends Widget ...@@ -42,13 +42,17 @@ class NavBar extends Widget
/** /**
* @var array the HTML attributes for the widget container tag. The following special options are recognized: * @var array the HTML attributes for the widget container tag. The following special options are recognized:
* *
* - tag: string, defaults to "nav", the name of the container tag * - tag: string, defaults to "nav", the name of the container tag.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
*/ */
public $options = []; public $options = [];
/** /**
* @var array the HTML attributes for the container tag. The following special options are recognized: * @var array the HTML attributes for the container tag. The following special options are recognized:
* *
* - tag: string, defaults to "div", the name of the container tag * - tag: string, defaults to "div", the name of the container tag.
*
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
*/ */
public $containerOptions = []; public $containerOptions = [];
/** /**
...@@ -63,6 +67,7 @@ class NavBar extends Widget ...@@ -63,6 +67,7 @@ class NavBar extends Widget
public $brandUrl; public $brandUrl;
/** /**
* @var array the HTML attributes of the brand link. * @var array the HTML attributes of the brand link.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
*/ */
public $brandOptions = []; public $brandOptions = [];
/** /**
...@@ -76,6 +81,7 @@ class NavBar extends Widget ...@@ -76,6 +81,7 @@ class NavBar extends Widget
public $renderInnerContainer = true; public $renderInnerContainer = true;
/** /**
* @var array the HTML attributes of the inner container. * @var array the HTML attributes of the inner container.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
*/ */
public $innerContainerOptions = []; public $innerContainerOptions = [];
......
...@@ -60,7 +60,7 @@ use yii\helpers\Html; ...@@ -60,7 +60,7 @@ use yii\helpers\Html;
class Progress extends Widget class Progress extends Widget
{ {
/** /**
* @var string the button label * @var string the button label.
*/ */
public $label; public $label;
/** /**
...@@ -68,7 +68,8 @@ class Progress extends Widget ...@@ -68,7 +68,8 @@ class Progress extends Widget
*/ */
public $percent = 0; public $percent = 0;
/** /**
* @var array the HTML attributes of the bar * @var array the HTML attributes of the bar.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
*/ */
public $barOptions = []; public $barOptions = [];
/** /**
...@@ -84,6 +85,7 @@ class Progress extends Widget ...@@ -84,6 +85,7 @@ class Progress extends Widget
* // optional, array, additional HTML attributes for the bar tag * // optional, array, additional HTML attributes for the bar tag
* 'options' => [], * 'options' => [],
* ] * ]
* ```
*/ */
public $bars; public $bars;
......
...@@ -75,16 +75,20 @@ class Tabs extends Widget ...@@ -75,16 +75,20 @@ class Tabs extends Widget
* by the "options" set in individual [[items]]. The following special options are recognized: * by the "options" set in individual [[items]]. The following special options are recognized:
* *
* - tag: string, defaults to "div", the tag name of the item container tags. * - 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.
*/ */
public $itemOptions = []; public $itemOptions = [];
/** /**
* @var array list of HTML attributes for the header container tags. This will be overwritten * @var array list of HTML attributes for the header container tags. This will be overwritten
* by the "headerOptions" set in individual [[items]]. * by the "headerOptions" set in individual [[items]].
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
*/ */
public $headerOptions = []; public $headerOptions = [];
/** /**
* @var array list of HTML attributes for the tab header link tags. This will be overwritten * @var array list of HTML attributes for the tab header link tags. This will be overwritten
* by the "linkOptions" set in individual [[items]]. * by the "linkOptions" set in individual [[items]].
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
*/ */
public $linkOptions = []; public $linkOptions = [];
/** /**
......
...@@ -21,6 +21,7 @@ class Widget extends \yii\base\Widget ...@@ -21,6 +21,7 @@ class Widget extends \yii\base\Widget
{ {
/** /**
* @var array the HTML attributes for the widget container tag. * @var array the HTML attributes for the widget container tag.
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
*/ */
public $options = []; 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