hiqdev / hidev-readme

src/controllers/ReadmeController.php

Doc Comments +15 added lines

@@ -26,6 +26,9 @@ 
         return Yii::$app->charset ?: mb_internal_encoding();
     }
 
+    /**
+     * @param string $char
+     */
     public function renderH($title, $char)
     {
         $res = $title . "\n";
@@ -34,16 +37,25 @@ 
         return $res . "\n";
     }
 
+    /**
+     * @param string $title
+     */
     public function renderH1($title)
     {
         return $this->renderH($title, '=');
     }
 
+    /**
+     * @param string $title
+     */
     public function renderH2($title)
     {
         return $this->renderH($title, '-');
     }
 
+    /**
+     * @param string $text
+     */
     public function renderText($text)
     {
         $text = trim($text);
@@ -68,6 +80,9 @@ 
         return $text ? "\n## $section\n\n$text\n" : '';
     }
 
+    /**
+     * @param string $file
+     */
     public function getSection($file, $default = null)
     {
         $view = Yii::$app->getView();

tests/functional/ReadmeTest.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
         $this->tester = null;
     }
 
+    /**
+     * @param string $subdir
+     */
     protected function prepare($subdir)
     {
         $dir = __DIR__ . DIRECTORY_SEPARATOR . $subdir;