NNTmux / newznab-tmux

nntmux/processing/tv/TVMaze.php

Doc Comments +3 added lines, -3 removed lines

@@ -55,8 +55,8 @@ 
      * Main processing director function for scrapers
      * Calls work query function and initiates processing.
      *
-     * @param      $groupID
-     * @param      $guidChar
+     * @param      string $groupID
+     * @param      string $guidChar
      * @param      $process
      * @param bool $local
      */
@@ -223,7 +223,7 @@ 
      * Returns a formatted array of show data or false if no match.
      *
      *
-     * @param string|null|array $cleanName
+     * @param string $cleanName
      * @return array|bool|false
      */
     protected function getShowInfo($cleanName)

nntmux/processing/tv/TraktTv.php

Doc Comments +3 added lines, -3 removed lines

@@ -91,8 +91,8 @@ 
      * Main processing director function for scrapers
      * Calls work query function and initiates processing.
      *
-     * @param      $groupID
-     * @param      $guidChar
+     * @param      string $groupID
+     * @param      string $guidChar
      * @param      $process
      * @param bool $local
      */
@@ -291,7 +291,7 @@ 
     /**
      * Retrieve info of TV programme from site using it's API.
      *
-     * @param string|null|array $name Title of programme to look up. Usually a cleaned up version from releases table.
+     * @param string $name Title of programme to look up. Usually a cleaned up version from releases table.
      *
      * @return array|false    False on failure, an array of information fields otherwise.
      */

nntmux/processing/tv/TV.php

Doc Comments +3 added lines, -3 removed lines

@@ -363,7 +363,7 @@ 
     /**
      * Sets the TV show's image column to found (1).
      *
-     * @param $videoId
+     * @param integer $videoId
      */
     public function setCoverFound($videoId): void
     {
@@ -375,8 +375,8 @@ 
      * Returns the ID value or false if none found.
      *
      *
-     * @param $column
-     * @param $id
+     * @param string $column
+     * @param integer $id
      * @return bool|\Illuminate\Database\Eloquent\Model|mixed|null|static
      */
     public function getSiteByID($column, $id)

nntmux/utility/Utility.php

Doc Comments +8 added lines, -5 removed lines

@@ -190,7 +190,7 @@ 
     /**
      * Detect if the command is accessible on the system.
      *
-     * @param $cmd
+     * @param string $cmd
      *
      * @return bool|null Returns true if found, false if not found, and null if which is not detected.
      */
@@ -280,7 +280,7 @@ 
     }
 
     /**
-     * @param array  $elements
+     * @param string[]  $elements
      * @param string $prefix
      *
      * @return string
@@ -307,7 +307,7 @@ 
      * Operates directly on the text string, but also returns the result for situations requiring a
      * return value (use in ternary, etc.)/
      *
-     * @param $text        String variable to strip.
+     * @param string $text        String variable to strip.
      *
      * @return string    The stripped variable.
      */
@@ -372,6 +372,9 @@ 
         return $string === '' ? false : $string;
     }
 
+    /**
+     * @param string|null $path
+     */
     public static function setCoversConstant($path)
     {
         if (! defined('NN_COVERS')) {
@@ -467,7 +470,7 @@ 
      *
      * @param array $options See details below.
      *
-     * @return bool|mixed
+     * @return string
      * @static
      */
     public static function getUrl(array $options = [])
@@ -1076,7 +1079,7 @@ 
     /**
      * Simple function to reduce duplication in html string formatting.
      *
-     * @param $string
+     * @param string $string
      *
      * @return string
      */

nntmux/processing/Videos.php

Doc Comments +1 added lines, -1 removed lines

@@ -236,7 +236,7 @@
     /**
      * Supplementary function for getByTitle that queries for a like match.
      *
-     * @param        $title
+     * @param        string $title
      * @param        $type
      * @param int    $source
      *

nntmux/ColorCLI.php

Doc Comments +7 added lines, -7 removed lines

@@ -186,7 +186,7 @@ 
     }
 
     /**
-     * @param $fg
+     * @param string $fg
      * @param string $opt
      * @param string $bg
      * @return string
@@ -206,7 +206,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public static function debug($str): string
@@ -215,7 +215,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public static function info($str): string
@@ -224,7 +224,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public static function notice($str): string
@@ -269,7 +269,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public static function alternate($str): string
@@ -278,7 +278,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public static function tmuxOrange($str): string
@@ -305,7 +305,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public static function alternateOver($str): string

nntmux/processing/post/ProcessAdditional.php

Doc Comments +6 added lines, -6 removed lines

@@ -548,7 +548,7 @@ 
     protected $tmpPath;
 
     /**
-     * @param $guidChar
+     * @param string $guidChar
      * @param string $groupID
      * @throws \RuntimeException
      * @throws \Exception
@@ -609,7 +609,7 @@ 
     /**
      * Get all releases that need to be processed.
      *
-     * @param int|string $groupID
+     * @param string $groupID
      * @param string     $guidChar
      *
      * @void
@@ -1695,7 +1695,7 @@ 
     }
 
     /**
-     * @param $fileLocation
+     * @param string $fileLocation
      * @param $fileExtension
      * @return bool
      * @throws \Exception
@@ -2165,7 +2165,7 @@ 
     }
 
     /**
-     * @param $fileLocation
+     * @param string $fileLocation
      * @throws \Exception
      */
     protected function _siftPAR2Info($fileLocation)
@@ -2252,7 +2252,7 @@ 
     }
 
     /**
-     * @param $fileLocation
+     * @param string $fileLocation
      * @throws \Exception
      */
     protected function _processNfoFile($fileLocation)
@@ -2268,7 +2268,7 @@ 
     }
 
     /**
-     * @param $fileLocation
+     * @param string $fileLocation
      * @throws \Exception
      */
     protected function _processVideoFile($fileLocation)

nntmux/NZBGet.php

Doc Comments +2 added lines, -2 removed lines

@@ -142,7 +142,7 @@ 
      *
      * @param string $guid Release identifier.
      *
-     * @return bool|mixed
+     * @return Request
      */
     public function sendURLToNZBGet($guid)
     {
@@ -407,7 +407,7 @@ 
      *
      * @param string $url NZBGet URL to verify.
      *
-     * @return bool|string
+     * @return string|false
      */
     public function verifyURL($url)
     {

nntmux/libraries/Cache.php

Doc Comments +3 added lines, -3 removed lines

@@ -39,9 +39,9 @@ 
      * Store data on the cache server.
      *
      *
-     * @param $key
+     * @param string $key
      * @param $data
-     * @param $expiration
+     * @param integer $expiration
      * @return bool
      * @throws \nntmux\libraries\CacheException
      */
@@ -64,7 +64,7 @@ 
      * Attempt to retrieve a value from the cache server, if not set it.
      *
      *
-     * @param $key
+     * @param string $key
      * @return bool|mixed|string
      * @throws \nntmux\libraries\CacheException
      */