Add phpdoc throws

Author: laurynas

lib/DetectLanguage/Client.php

@@ -28,10 +28,12 @@ class Client
     /**
      * Perform a request
      *
-     * @param string $method Method name
-     * @param array $payload Request payload
+     * @param string $method HTTP method name (GET, POST, etc.)
+     * @param string $path API endpoint path
+     * @param array|null $payload Request payload data
      *
-     * @return object
+     * @return array Response data
+     * @throws \DetectLanguage\Error When API request fails, invalid response received, or authentication fails
      */
     public static function request($method, $path, $payload = null)
     {
@@ -55,11 +57,6 @@ public static function request($method, $path, $payload = null)
         return $response;
     }
 
-    /**
-     * Get request method name.
-     *
-     * @return string
-     */
     protected static function getEngineMethodName()
     {
         $request_engine = self::$requestEngine;
@@ -84,8 +81,9 @@ protected static function getEngineMethodName()
     /**
      * Perform request using native PHP streams
      *
+     * @param string $method HTTP method name
      * @param string $url Request URL
-     * @param string $body Request body
+     * @param string|null $body Request body
      *
      * @return string Response body
      */
@@ -112,10 +110,12 @@ protected static function requestStream($method, $url, $body)
     /**
      * Perform request using CURL extension.
      *
+     * @param string $method HTTP method name
      * @param string $url Request URL
-     * @param string $body Request body
+     * @param string|null $body Request body
      *
      * @return string Response body
+     * @throws \DetectLanguage\Error When CURL request fails, times out, or connection fails
      */
     protected static function requestCurl($method, $url, $body)
     {
@@ -154,7 +154,7 @@ protected static function requestCurl($method, $url, $body)
      * Build URL for given method
      *
      * @param string $method Method name
-     * @return string
+     * @return string Complete API URL
      */
     protected static function getUrl($method)
     {
@@ -164,7 +164,7 @@ protected static function getUrl($method)
     /**
      * Build request headers.
      *
-     * @return array
+     * @return array Array of HTTP headers
      */
     protected static function getHeaders()
     {
@@ -179,7 +179,7 @@ protected static function getHeaders()
     /**
      * Get User-Agent for the request.
      *
-     * @return string
+     * @return string User-Agent string
      */
     protected static function getUserAgent()
     {

lib/DetectLanguage/DetectLanguage.php

@@ -42,7 +42,8 @@ class DetectLanguage
      * Set API key
      *
      * @static
-     * @param string $apiKey
+     * @param string $apiKey The API key for authentication
+     * @return void
      */
     public static function setApiKey($apiKey)
     {
@@ -54,7 +55,8 @@ public static function setApiKey($apiKey)
      *
      * @static
      * @param string $text The text for language detection
-     * @return array detected languages information
+     * @return array Detected languages information
+     * @throws \DetectLanguage\Error When API request fails, invalid response received, or authentication fails
      */
     public static function detect($text)
     {
@@ -71,7 +73,8 @@ public static function detect($text)
      *
      * @static
      * @param string $text The text for language detection
-     * @return string|null detected language code
+     * @return string|null Detected language code
+     * @throws \DetectLanguage\Error When API request fails, invalid response received, or authentication fails
      */
     public static function detectCode($text)
     {
@@ -88,7 +91,8 @@ public static function detectCode($text)
      *
      * @static
      * @param array $texts The texts for language detection
-     * @return array detected languages information
+     * @return array Detected languages information
+     * @throws \DetectLanguage\Error When API request fails, invalid response received, or authentication fails
      */
     public static function detectBatch($texts)
     {
@@ -100,6 +104,7 @@ public static function detectBatch($texts)
      *
      * @static
      * @return array account status information
+     * @throws \DetectLanguage\Error When API request fails, invalid response received, or authentication fails
      */
     public static function getStatus()
     {
@@ -110,7 +115,8 @@ public static function getStatus()
      * Get supported languages.
      *
      * @static
-     * @return array languages information
+     * @return array Supported languages information
+     * @throws \DetectLanguage\Error When API request fails, invalid response received, or authentication fails
      */
     public static function getLanguages()
     {
@@ -122,7 +128,8 @@ public static function getLanguages()
     /**
      * @deprecated use self::detectCode instead
      * @param string $text The text for language detection
-     * @return string|null detected language code
+     * @return string|null Detected language code
+     * @throws \DetectLanguage\Error When API request fails, invalid response received, or authentication fails
      */
     public static function simpleDetect($text)
     {

lib/DetectLanguage/Error.php

@@ -2,7 +2,9 @@
 
 namespace DetectLanguage;
 
-// backwards compatibility
+/**
+ * @deprecated Use Error class instead
+ */
 class DetectLanguageError extends \Exception
 {
 }