docs(project): improve phpdoc

Author: EdouardCourty

src/Exception/SocketException.php

@@ -4,6 +4,9 @@
 
 namespace TorPHP\Exception;
 
+/**
+ * @author Edouard Courty
+ */
 class SocketException extends \Exception
 {
 }

src/Helper/PrivateKeyHelper.php

@@ -4,12 +4,20 @@
 
 namespace TorPHP\Helper;
 
+/**
+ * Helper class for private key management.
+ *
+ * @author Edouard Courty
+ */
 class PrivateKeyHelper
 {
     public const string NO_PRIVATE_KEY = 'NEW:' . self::PRIVATE_KEY_PREFIX;
 
     private const string PRIVATE_KEY_PREFIX = 'ED25519-V3';
 
+    /**
+     * Parse the private key to ensure it has the correct prefix.
+     */
     public static function parsePrivateKey(string $privateKey): string
     {
         if (str_starts_with($privateKey, self::PRIVATE_KEY_PREFIX) === true) {

src/Model/Circuit.php

@@ -4,6 +4,11 @@
 
 namespace TorPHP\Model;
 
+/**
+ * Represents a Tor circuit.
+ *
+ * @author Edouard Courty
+ */
 class Circuit
 {
     /**

src/Model/OnionService.php

@@ -4,6 +4,11 @@
 
 namespace TorPHP\Model;
 
+/**
+ * Represents a Tor Onion service.
+ *
+ * @author Edouard Courty
+ */
 class OnionService
 {
     public function __construct(

src/Model/PortMapping.php

@@ -4,6 +4,11 @@
 
 namespace TorPHP\Model;
 
+/**
+ * Represents a port mapping for a Tor hidden service.
+ *
+ * @author Edouard Courty
+ */
 class PortMapping
 {
     public function __construct(

src/TorControlClient.php

@@ -39,6 +39,10 @@ public function __construct(
         $this->authenticate();
     }
 
+    /**
+     * Helper method to assert the response from Tor ControlPort.
+     * Returns the response string if successful.
+     */
     private function assertSuccessResponse(): string
     {
         $response = $this->socketClient->readLine();
@@ -55,7 +59,7 @@ private function assertSuccessResponse(): string
     }
 
     /**
-     * Authenticates against the Tor ControlPort using password or cookie.
+     * Helper method to authenticate against the Tor ControlPort using password or cookie.
      */
     private function authenticate(): void
     {
@@ -136,6 +140,8 @@ public function close(): void
     }
 
     /**
+     * Fetches the current Tor circuits the node has.
+     *
      * @return Circuit[]
      */
     public function getCircuits(): array

src/TorHttpClient.php

@@ -121,6 +121,9 @@ public function newIdentity(): void
         $torControlClient->close();
     }
 
+    /**
+     * Helper method to build the HTTP client with the current options.
+     */
     private function buildHttpClient(): void
     {
         $this->httpClient = $this->baseHttpClient->withOptions($this->clientOptions);

src/Transport/TorSocketClient.php

@@ -47,6 +47,9 @@ public function connect(): void
         $this->socket = $socket;
     }
 
+    /**
+     * Helper method to write to the socket
+     */
     public function write(string $data): void
     {
         $this->ensureConnected();
@@ -57,6 +60,9 @@ public function write(string $data): void
         }
     }
 
+    /**
+     * Reads one line from the socket
+     */
     public function readLine(): ?string
     {
         $this->ensureConnected();
@@ -70,6 +76,8 @@ public function readLine(): ?string
     }
 
     /**
+     * Reads a block of data from the socket until the specified string is found.
+     *
      * @return string[]
      */
     public function readBlock(string $until): array
@@ -101,6 +109,9 @@ public function readBlock(string $until): array
         return $buffer;
     }
 
+    /**
+     * Closes the socket connection.
+     */
     public function close(): void
     {
         if (\is_resource($this->socket) === true) {
@@ -110,6 +121,9 @@ public function close(): void
         $this->socket = false;
     }
 
+    /**
+     * Helper method to check if the socket is instantiated
+     */
     private function ensureConnected(): void
     {
         if (\is_resource($this->socket) === false) {