release version 2.0.6

Author: cebe

CHANGELOG.md

@@ -1,7 +1,7 @@
 Yii Framework 2 apidoc extension Change Log
 ===========================================
 
-2.0.6 under development
+2.0.6 November 22, 2016
 -----------------------
 
 - Bug #5: Enable display of deprecated information for methods, properties, constants and events (cebe)

commands/ApiController.php

@@ -37,7 +37,7 @@ class ApiController extends BaseController
      * Renders API documentation files
      * @param array $sourceDirs
      * @param string $targetDir
-     * @return integer
+     * @return int
      */
     public function actionIndex(array $sourceDirs, $targetDir)
     {

commands/GuideController.php

@@ -39,7 +39,7 @@ class GuideController extends BaseController
      * Renders API documentation files
      * @param array $sourceDirs
      * @param string $targetDir
-     * @return integer
+     * @return int
      */
     public function actionIndex(array $sourceDirs, $targetDir)
     {

components/BaseController.php

@@ -38,7 +38,7 @@ abstract class BaseController extends Controller
     /**
      * Checks that target directory is valid. Asks questions in tricky cases.
      * @param string $target
-     * @return boolean|string
+     * @return bool|string
      */
     protected function normalizeTargetDir($target)
     {
@@ -64,7 +64,7 @@ protected function normalizeTargetDir($target)
     /**
      * Finds files to process
      * @param array $sourceDirs
-     * @return array|boolean list of files to process or false on failure
+     * @return array|bool list of files to process or false on failure
      */
     protected function searchFiles($sourceDirs)
     {

helpers/ApiMarkdown.php

@@ -214,7 +214,7 @@ protected function translateBlockType($type)
      *
      * @param string $content
      * @param TypeDoc $context
-     * @param boolean $paragraph
+     * @param bool $paragraph
      * @return string
      */
     public static function process($content, $context = null, $paragraph = false)

helpers/ApiMarkdownLaTeX.php

@@ -80,7 +80,7 @@ protected function renderQuote($block)
      *
      * @param string $content
      * @param TypeDoc $context
-     * @param boolean $paragraph
+     * @param bool $paragraph
      * @return string
      */
     public static function process($content, $context = null, $paragraph = false)

models/BaseDoc.php

@@ -42,7 +42,7 @@ class BaseDoc extends Object
     /**
      * Checks if doc has tag of a given name
      * @param string $name tag name
-     * @return boolean if doc has tag of a given name
+     * @return bool if doc has tag of a given name
      */
     public function hasTag($name)
     {

models/Context.php

@@ -436,8 +436,8 @@ protected function handlePropertyFeature($class)
     /**
      * Check whether a method has `$number` non-optional parameters.
      * @param MethodDoc $method
-     * @param integer $number number of not optional parameters
-     * @return boolean
+     * @param int $number number of not optional parameters
+     * @return bool
      */
     private function hasNonOptionalParams($method, $number = 0)
     {
@@ -467,7 +467,7 @@ private function getFirstNotOptionalParameter($method)
     /**
      * @param ClassDoc $classA
      * @param ClassDoc|string $classB
-     * @return boolean
+     * @return bool
      */
     protected function isSubclassOf($classA, $classB)
     {

models/PropertyDoc.php

@@ -13,8 +13,8 @@
 /**
  * Represents API documentation information for a `property`.
  *
- * @property boolean $isReadOnly If property is read only. This property is read-only.
- * @property boolean $isWriteOnly If property is write only. This property is read-only.
+ * @property bool $isReadOnly If property is read only. This property is read-only.
+ * @property bool $isWriteOnly If property is write only. This property is read-only.
  *
  * @author Carsten Brandt <mail@cebe.cc>
  * @since 2.0
@@ -34,15 +34,15 @@ class PropertyDoc extends BaseDoc
 
 
     /**
-     * @return boolean if property is read only
+     * @return bool if property is read only
      */
     public function getIsReadOnly()
     {
         return $this->getter !== null && $this->setter === null;
     }
 
     /**
-     * @return boolean if property is write only
+     * @return bool if property is write only
      */
     public function getIsWriteOnly()
     {

templates/bootstrap/SideNavWidget.php

@@ -120,7 +120,7 @@ public function renderItems()
     /**
      * Renders a widget's item.
      * @param string|array $item the item to render.
-     * @param boolean $collapsed whether to collapse item if not active
+     * @param bool $collapsed whether to collapse item if not active
      * @throws \yii\base\InvalidConfigException
      * @return string the rendering result.
      * @throws InvalidConfigException if label is not defined