hiqdev / hidev-readme

src/components/Readme.php

Doc Comments +15 added lines

@@ -42,16 +42,25 @@ 
         return (isset(Yii::$app->charset) ? Yii::$app->charset : null) ?: mb_internal_encoding();
     }
 
+    /**
+     * @param string $prefix
+     */
     public function renderH($title, $prefix)
     {
         return $prefix . ' ' . $title . "\n";
     }
 
+    /**
+     * @param string $title
+     */
     public function renderH1($title)
     {
         return $this->renderH($title, '#');
     }
 
+    /**
+     * @param string $title
+     */
     public function renderH2($title)
     {
         return $this->renderH($title, '##');
@@ -62,6 +71,9 @@ 
         return $this->renderH($title, '###');
     }
 
+    /**
+     * @param string $text
+     */
     public function renderText($text)
     {
         $text = trim($text);
@@ -86,6 +98,9 @@ 
         return $text ? "\n## $section\n\n$text\n" : '';
     }
 
+    /**
+     * @param string $file
+     */
     public function getSection($file, $default = null)
     {
         $tpl = '@hidev/views/' . Helper::file2template($file);