Browse Source

fixed all the PHPdoc in extensions

tags/2.0.0-rc
Carsten Brandt 11 years ago
parent
commit
20d4429fdd
  1. 6
      Carousel.php
  2. 8
      Collapse.php
  3. 4
      Dropdown.php
  4. 6
      Nav.php
  5. 2
      NavBar.php
  6. 10
      Progress.php
  7. 8
      Tabs.php

6
Carousel.php

@ -117,9 +117,9 @@ class Carousel extends Widget
/** /**
* Renders a single carousel item * Renders a single carousel item
* @param string|array $item a single item from [[items]] * @param string|array $item a single item from [[items]]
* @param integer $index the item index as the first item should be set to `active` * @param integer $index the item index as the first item should be set to `active`
* @return string the rendering result * @return string the rendering result
* @throws InvalidConfigException if the item is invalid * @throws InvalidConfigException if the item is invalid
*/ */
public function renderItem($item, $index) public function renderItem($item, $index)

8
Collapse.php

@ -98,10 +98,10 @@ class Collapse extends Widget
/** /**
* Renders a single collapsible item group * Renders a single collapsible item group
* @param string $header a label of the item group [[items]] * @param string $header a label of the item group [[items]]
* @param array $item a single item from [[items]] * @param array $item a single item from [[items]]
* @param integer $index the item index as each item group content must have an id * @param integer $index the item index as each item group content must have an id
* @return string the rendering result * @return string the rendering result
* @throws InvalidConfigException * @throws InvalidConfigException
*/ */
public function renderItem($header, $item, $index) public function renderItem($header, $item, $index)

4
Dropdown.php

@ -62,8 +62,8 @@ class Dropdown extends Widget
/** /**
* Renders menu items. * Renders menu items.
* @param array $items the menu items to be rendered * @param array $items the menu items to be rendered
* @return string the rendering result. * @return string the rendering result.
* @throws InvalidConfigException if the label option is not specified in one of the items. * @throws InvalidConfigException if the label option is not specified in one of the items.
*/ */
protected function renderItems($items) protected function renderItems($items)

6
Nav.php

@ -136,8 +136,8 @@ class Nav extends Widget
/** /**
* Renders a widget's item. * Renders a widget's item.
* @param string|array $item the item to render. * @param string|array $item the item to render.
* @return string the rendering result. * @return string the rendering result.
* @throws InvalidConfigException * @throws InvalidConfigException
*/ */
public function renderItem($item) public function renderItem($item)
@ -211,7 +211,7 @@ class Nav extends Widget
* as the route for the item and the rest of the elements are the associated parameters. * as the route for the item and the rest of the elements are the associated parameters.
* Only when its route and parameters match [[route]] and [[params]], respectively, will a menu item * Only when its route and parameters match [[route]] and [[params]], respectively, will a menu item
* be considered active. * be considered active.
* @param array $item the menu item to be checked * @param array $item the menu item to be checked
* @return boolean whether the menu item is active * @return boolean whether the menu item is active
*/ */
protected function isItemActive($item) protected function isItemActive($item)

2
NavBar.php

@ -62,7 +62,7 @@ class NavBar extends Widget
public $brandLabel; public $brandLabel;
/** /**
* @param array|string $url the URL for the brand's hyperlink tag. This parameter will be processed by [[Url::to()]] * @param array|string $url the URL for the brand's hyperlink tag. This parameter will be processed by [[Url::to()]]
* and will be used for the "href" attribute of the brand link. If not set, [[\yii\web\Application::homeUrl]] will be used. * and will be used for the "href" attribute of the brand link. If not set, [[\yii\web\Application::homeUrl]] will be used.
*/ */
public $brandUrl; public $brandUrl;
/** /**

10
Progress.php

@ -112,7 +112,7 @@ class Progress extends Widget
/** /**
* Renders the progress. * Renders the progress.
* @return string the rendering result. * @return string the rendering result.
* @throws InvalidConfigException if the "percent" option is not set in a stacked progress bar. * @throws InvalidConfigException if the "percent" option is not set in a stacked progress bar.
*/ */
protected function renderProgress() protected function renderProgress()
@ -135,10 +135,10 @@ class Progress extends Widget
/** /**
* Generates a bar * Generates a bar
* @param integer $percent the percentage of the bar * @param integer $percent the percentage of the bar
* @param string $label, optional, the label to display at the bar * @param string $label, optional, the label to display at the bar
* @param array $options the HTML attributes of the bar * @param array $options the HTML attributes of the bar
* @return string the rendering result. * @return string the rendering result.
*/ */
protected function renderBar($percent, $label = '', $options = []) protected function renderBar($percent, $label = '', $options = [])
{ {

8
Tabs.php

@ -120,7 +120,7 @@ class Tabs extends Widget
/** /**
* Renders tab items as specified on [[items]]. * Renders tab items as specified on [[items]].
* @return string the rendering result. * @return string the rendering result.
* @throws InvalidConfigException. * @throws InvalidConfigException.
*/ */
protected function renderItems() protected function renderItems()
@ -192,9 +192,9 @@ class Tabs extends Widget
/** /**
* Normalizes dropdown item options by removing tab specific keys `content` and `contentOptions`, and also * Normalizes dropdown item options by removing tab specific keys `content` and `contentOptions`, and also
* configure `panes` accordingly. * configure `panes` accordingly.
* @param array $items the dropdown items configuration. * @param array $items the dropdown items configuration.
* @param array $panes the panes reference array. * @param array $panes the panes reference array.
* @return boolean whether any of the dropdown items is `active` or not. * @return boolean whether any of the dropdown items is `active` or not.
* @throws InvalidConfigException * @throws InvalidConfigException
*/ */
protected function renderDropdown(&$items, &$panes) protected function renderDropdown(&$items, &$panes)

Loading…
Cancel
Save