Update doc blocks

.github/workflows/tests.yml

@@ -23,7 +23,7 @@ jobs:
         run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
 
       - name: Run PHP CodeSniffer
-        run: vendor/bin/phpcs --severity=6
+        run: vendor/bin/phpcs --severity=6 # change to 1
 
       - name: Run PHP Stan
         run: vendor/bin/phpstan analyse src --level=8

phpcs.xml

@@ -1,26 +1,17 @@
 <?xml version="1.0"?>
 <ruleset name="Custom Ruleset">
-    <description>PSR-12</description>
+    <description>PSR-12 with custom sniffs</description>
 
     <!-- Set the coding standard to PSR-12 -->
-    <rule ref="PSR12">
-        <severity>10</severity>
-    </rule>
+    <rule ref="PSR12"/>
 
     <!-- Add custom rules for PHPDoc -->
-    <rule ref="Squiz.Commenting.ClassComment">
-        <severity>5</severity>
-    </rule>
-    <rule ref="Squiz.Commenting.FunctionComment">
-        <severity>5</severity>
-    </rule>
-    <rule ref="Squiz.Commenting.VariableComment">
-        <severity>5</severity>
-    </rule>
+    <rule ref="Squiz.Commenting.ClassComment"/>
+    <rule ref="Squiz.Commenting.FunctionComment"/>
+    <rule ref="Squiz.Commenting.VariableComment"/>
 
     <!-- Add rule to remove unused use statements -->
     <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
-        <severity>6</severity>
         <properties>
             <property name="searchAnnotations" value="true"/>
         </properties>

src/Client.php

@@ -88,19 +88,7 @@
 use Timirey\XApi\Responses\TradeTransactionStatusResponse;
 
 /**
- * Class Client
- *
  * A client for interacting with the xStation5 API.
- *
- * @package Timirey\XApi
- *
- * @property SocketConnection $request Connection for sending requests.
- * @property SocketConnection $stream Connection for handling streaming data.
- * @property string $streamSessionId Session ID for the streaming connection.
- * @property int $userId User ID for login.
- * @property string $password User password for login.
- * @property Host $host Host configuration.
- * @property string|null $appName Optional application name.
  */
 class Client
 {

src/Enums/Host.php

@@ -8,16 +8,12 @@
 enum Host: string
 {
     /**
-     * Demo account type.
-     *
-     * @var string
+     * @const Demo account type.
      */
     case DEMO = 'demo';
 
     /**
-     * Real account type.
-     *
-     * @var string
+     * @const Real account type.
      */
     case REAL = 'real';
 

src/Payloads/AbstractStreamPayload.php

@@ -2,7 +2,6 @@
 
 namespace Timirey\XApi\Payloads;
 
-use JsonException;
 use Override;
 use Timirey\XApi\Exceptions\InvalidPayloadException;
 
@@ -22,12 +21,7 @@ public function __construct(string $streamSessionId)
     }
 
     /**
-     * Convert the object to JSON.
-     *
-     * @return string JSON representation of the payload.
-     *
-     * @throws JsonException If encoding to JSON fails.
-     * @throws InvalidPayloadException If payload is not valid.
+     * @inheritdoc
      */
     #[Override]
     public function toJson(): string

src/Payloads/GetAllSymbolsPayload.php

@@ -10,9 +10,7 @@
 final class GetAllSymbolsPayload extends AbstractPayload
 {
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetCalendarPayload.php

@@ -10,9 +10,7 @@
 final class GetCalendarPayload extends AbstractPayload
 {
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetChartLastRequestPayload.php

@@ -21,9 +21,7 @@ public function __construct(ChartLastInfoRecord $chartLastInfoRecord)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetChartRangeRequestPayload.php

@@ -21,9 +21,7 @@ public function __construct(ChartRangeInfoRecord $chartRangeInfoRecord)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetCommissionDefPayload.php

@@ -24,9 +24,7 @@ public function __construct(string $symbol, float $volume)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetCurrentUserDataPayload.php

@@ -10,9 +10,7 @@
 final class GetCurrentUserDataPayload extends AbstractPayload
 {
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetIbsHistoryPayload.php

@@ -26,9 +26,7 @@ public function __construct(DateTime $start, DateTime $end)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetMarginLevelPayload.php

@@ -10,9 +10,7 @@
 final class GetMarginLevelPayload extends AbstractPayload
 {
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetMarginTradePayload.php

@@ -24,9 +24,7 @@ public function __construct(string $symbol, float $volume)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetNewsPayload.php

@@ -26,9 +26,7 @@ public function __construct(DateTime $start, DateTime $end)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetProfitCalculationPayload.php

@@ -31,9 +31,7 @@ public function __construct(float $closePrice, Cmd $cmd, float $openPrice, strin
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetServerTimePayload.php

@@ -10,9 +10,7 @@
 final class GetServerTimePayload extends AbstractPayload
 {
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetStepRulesPayload.php

@@ -10,9 +10,7 @@
 final class GetStepRulesPayload extends AbstractPayload
 {
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetSymbolPayload.php

@@ -20,9 +20,7 @@ public function __construct(string $symbol)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetTickPricesPayload.php

@@ -29,9 +29,7 @@ public function __construct(Level $level, array $symbols, DateTime $timestamp)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetTradeRecordsPayload.php

@@ -20,9 +20,7 @@ public function __construct(array $orders)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetTradesHistoryPayload.php

@@ -26,9 +26,7 @@ public function __construct(DateTime $start, DateTime $end)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetTradesPayload.php

@@ -20,9 +20,7 @@ public function __construct(bool $openedOnly)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetTradingHoursPayload.php

@@ -20,9 +20,7 @@ public function __construct(array $symbols)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/GetVersionPayload.php

@@ -10,9 +10,7 @@
 final class GetVersionPayload extends AbstractPayload
 {
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/LoginPayload.php

@@ -28,9 +28,7 @@ public function __construct(int $userId, string $password, ?string $appName = nu
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/LogoutPayload.php

@@ -10,9 +10,7 @@
 final class LogoutPayload extends AbstractPayload
 {
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/PingPayload.php

@@ -10,9 +10,7 @@
 final class PingPayload extends AbstractPayload
 {
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/PingStreamPayload.php

@@ -10,9 +10,7 @@
 final class PingStreamPayload extends AbstractStreamPayload
 {
     /**
-     * Returns the command name for the payload.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/TradeTransactionPayload.php

@@ -21,9 +21,7 @@ public function __construct(TradeTransInfo $tradeTransInfo)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string

src/Payloads/TradeTransactionStatusPayload.php

@@ -20,9 +20,7 @@ public function __construct(public int $order)
     }
 
     /**
-     * Get the command.
-     *
-     * @return string Command name.
+     * @inheritdoc
      */
     #[Override]
     protected function getCommand(): string