Browse Source

cleanup phpdoc

tags/2.0.5
Carsten Brandt 9 years ago
parent
commit
c25dc1e23d
  1. 1
      ActiveField.php
  2. 10
      BaseHtml.php
  3. 1
      Collapse.php

1
ActiveField.php

@ -298,6 +298,7 @@ class ActiveField extends \yii\widgets\ActiveField
* *
* @return $this the field object itself * @return $this the field object itself
* @since 2.0.5 * @since 2.0.5
* @see http://getbootstrap.com/css/#forms-controls-static
*/ */
public function staticControl($options = []) public function staticControl($options = [])
{ {

10
BaseHtml.php

@ -20,8 +20,7 @@ use yii\helpers\ArrayHelper;
class BaseHtml extends \yii\helpers\Html class BaseHtml extends \yii\helpers\Html
{ {
/** /**
* Composes icon HTML. * Composes icon HTML for bootstrap Glyphicons.
* @see http://getbootstrap.com/components/#glyphicons
* @param string $name icon short name, for example: 'star' * @param string $name icon short name, for example: 'star'
* @param array $options the tag options in terms of name-value pairs. These will be rendered as * @param array $options the tag options in terms of name-value pairs. These will be rendered as
* the attributes of the resulting tag. There are also a special options: * the attributes of the resulting tag. There are also a special options:
@ -30,6 +29,7 @@ class BaseHtml extends \yii\helpers\Html
* - prefix: string, prefix which should be used to compose tag class, by default 'glyphicon glyphicon-' is used. * - prefix: string, prefix which should be used to compose tag class, by default 'glyphicon glyphicon-' is used.
* *
* @return string icon HTML. * @return string icon HTML.
* @see http://getbootstrap.com/components/#glyphicons
*/ */
public static function icon($name, $options = []) public static function icon($name, $options = [])
{ {
@ -41,7 +41,7 @@ class BaseHtml extends \yii\helpers\Html
/** /**
* Renders Bootstrap static form control. * Renders Bootstrap static form control.
* @see http://getbootstrap.com/css/#forms-controls-static *
* By default value will be HTML-encoded using [[encode()]], you may control this behavior * By default value will be HTML-encoded using [[encode()]], you may control this behavior
* via 'encode' option. * via 'encode' option.
* @param string $value static control value. * @param string $value static control value.
@ -51,6 +51,7 @@ class BaseHtml extends \yii\helpers\Html
* - encode: boolean, whether value should be HTML-encoded or not. * - encode: boolean, whether value should be HTML-encoded or not.
* *
* @return string generated HTML * @return string generated HTML
* @see http://getbootstrap.com/css/#forms-controls-static
*/ */
public static function staticControl($value, $options = []) public static function staticControl($value, $options = [])
{ {
@ -72,6 +73,7 @@ class BaseHtml extends \yii\helpers\Html
* about attribute expression. * about attribute expression.
* @param array $options the tag options in terms of name-value pairs. See [[staticControl()]] for details. * @param array $options the tag options in terms of name-value pairs. See [[staticControl()]] for details.
* @return string generated HTML * @return string generated HTML
* @see staticControl()
*/ */
public static function activeStaticControl($model, $attribute, $options = []) public static function activeStaticControl($model, $attribute, $options = [])
{ {
@ -83,4 +85,4 @@ class BaseHtml extends \yii\helpers\Html
} }
return static::staticControl($value, $options); return static::staticControl($value, $options);
} }
} }

1
Collapse.php

@ -65,7 +65,6 @@ class Collapse extends Widget
* - contentOptions: optional, the HTML attributes of the group's content * - contentOptions: optional, the HTML attributes of the group's content
*/ */
public $items = []; public $items = [];
/** /**
* @var boolean whether the labels for header items should be HTML-encoded. * @var boolean whether the labels for header items should be HTML-encoded.
*/ */

Loading…
Cancel
Save