From 20d4429fddf89c8d3b4cee6ea05d912908f9de89 Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Wed, 23 Apr 2014 03:25:11 +0200 Subject: [PATCH] fixed all the PHPdoc in extensions --- Carousel.php | 6 +++--- Collapse.php | 8 ++++---- Dropdown.php | 4 ++-- Nav.php | 6 +++--- NavBar.php | 2 +- Progress.php | 10 +++++----- Tabs.php | 8 ++++---- 7 files changed, 22 insertions(+), 22 deletions(-) diff --git a/Carousel.php b/Carousel.php index 40291a2..90fe0bd 100644 --- a/Carousel.php +++ b/Carousel.php @@ -117,9 +117,9 @@ class Carousel extends Widget /** * Renders a single carousel item - * @param string|array $item a single item from [[items]] - * @param integer $index the item index as the first item should be set to `active` - * @return string the rendering result + * @param string|array $item a single item from [[items]] + * @param integer $index the item index as the first item should be set to `active` + * @return string the rendering result * @throws InvalidConfigException if the item is invalid */ public function renderItem($item, $index) diff --git a/Collapse.php b/Collapse.php index b8fb97c..c4f42ca 100644 --- a/Collapse.php +++ b/Collapse.php @@ -98,10 +98,10 @@ class Collapse extends Widget /** * Renders a single collapsible item group - * @param string $header a label of the item group [[items]] - * @param array $item a single item from [[items]] - * @param integer $index the item index as each item group content must have an id - * @return string the rendering result + * @param string $header a label of the item group [[items]] + * @param array $item a single item from [[items]] + * @param integer $index the item index as each item group content must have an id + * @return string the rendering result * @throws InvalidConfigException */ public function renderItem($header, $item, $index) diff --git a/Dropdown.php b/Dropdown.php index 8109add..fa8f178 100644 --- a/Dropdown.php +++ b/Dropdown.php @@ -62,8 +62,8 @@ class Dropdown extends Widget /** * Renders menu items. - * @param array $items the menu items to be rendered - * @return string the rendering result. + * @param array $items the menu items to be rendered + * @return string the rendering result. * @throws InvalidConfigException if the label option is not specified in one of the items. */ protected function renderItems($items) diff --git a/Nav.php b/Nav.php index a215914..fb9e560 100644 --- a/Nav.php +++ b/Nav.php @@ -136,8 +136,8 @@ class Nav extends Widget /** * Renders a widget's item. - * @param string|array $item the item to render. - * @return string the rendering result. + * @param string|array $item the item to render. + * @return string the rendering result. * @throws InvalidConfigException */ 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. * Only when its route and parameters match [[route]] and [[params]], respectively, will a menu item * 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 */ protected function isItemActive($item) diff --git a/NavBar.php b/NavBar.php index ab681d1..af41725 100644 --- a/NavBar.php +++ b/NavBar.php @@ -62,7 +62,7 @@ class NavBar extends Widget public $brandLabel; /** * @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; /** diff --git a/Progress.php b/Progress.php index ec0827a..1c466f6 100644 --- a/Progress.php +++ b/Progress.php @@ -112,7 +112,7 @@ class Progress extends Widget /** * 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. */ protected function renderProgress() @@ -135,10 +135,10 @@ class Progress extends Widget /** * Generates a bar - * @param integer $percent the percentage of the bar - * @param string $label, optional, the label to display at the bar - * @param array $options the HTML attributes of the bar - * @return string the rendering result. + * @param integer $percent the percentage of the bar + * @param string $label, optional, the label to display at the bar + * @param array $options the HTML attributes of the bar + * @return string the rendering result. */ protected function renderBar($percent, $label = '', $options = []) { diff --git a/Tabs.php b/Tabs.php index 7c7274a..b5669f6 100644 --- a/Tabs.php +++ b/Tabs.php @@ -120,7 +120,7 @@ class Tabs extends Widget /** * Renders tab items as specified on [[items]]. - * @return string the rendering result. + * @return string the rendering result. * @throws InvalidConfigException. */ 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 * configure `panes` accordingly. - * @param array $items the dropdown items configuration. - * @param array $panes the panes reference array. - * @return boolean whether any of the dropdown items is `active` or not. + * @param array $items the dropdown items configuration. + * @param array $panes the panes reference array. + * @return boolean whether any of the dropdown items is `active` or not. * @throws InvalidConfigException */ protected function renderDropdown(&$items, &$panes)