mantas-done / subtitles

src/Subtitles.php

Doc Comments +28 added lines

@@ -2,14 +2,35 @@ 
 
 interface SubtitleContract {
 
+    /**
+     * @return void
+     */
     public static function convert($from_file_path, $to_file_path);
 
+    /**
+     * @return Subtitles
+     */
     public static function load($file_name, $extension = null); // load file
+
+    /**
+     * @return Subtitles
+     */
     public function save($file_name); // save file
     public function content($format); // output file content (instead of saving to file)
 
+    /**
+     * @return Subtitles
+     */
     public function add($start, $end, $text); // add one line // @TODO ability to add multilines
+
+    /**
+     * @return Subtitles
+     */
     public function remove($from, $till); // delete test from subtitles
+
+    /**
+     * @return Subtitles
+     */
     public function time($seconds); // shift time
 
 
@@ -32,6 +53,10 @@ 
 
 
     // input
+
+    /**
+     * @return Subtitles
+     */
     public static function loadString($string, $extension);
 
     // chose format
@@ -182,6 +207,9 @@ 
 //        ));
 //    }
 
+    /**
+     * @param string $format
+     */
     public function content($format)
     {
         $format = strtolower(trim($format, '.'));