Addded PHPDoc blocks

Author: MarcinOrlowski

src/ResponseBuilder.php

@@ -24,7 +24,6 @@
  */
 class ResponseBuilder extends ResponseBuilderBase
 {
-
     /** @var bool */
     protected $success = false;
 
@@ -123,13 +122,23 @@ public static function error(int $api_code, array $placeholders = null, $data =
             ->build();
     }
 
-// -----------------------------------------------------------------------------------------------------------
+    // -----------------------------------------------------------------------------------------------------------
 
+    /**
+     * @param int|null $api_code
+     *
+     * @return \MarcinOrlowski\ResponseBuilder\ResponseBuilder
+     */
     public static function asSuccess(int $api_code = null): self
     {
         return new self(true, $api_code ?? BaseApiCodes::OK());
     }
 
+    /**
+     * @param int $api_code
+     *
+     * @return \MarcinOrlowski\ResponseBuilder\ResponseBuilder
+     */
     public static function asError(int $api_code): self
     {
         $code_ok = BaseApiCodes::OK();
@@ -144,6 +153,11 @@ public static function asError(int $api_code): self
         return new self(false, $api_code);
     }
 
+    /**
+     * @param int|null $http_code
+     *
+     * @return $this
+     */
     public function withHttpCode(int $http_code = null): self
     {
         Validator::assertIsType('http_code', $http_code, [Validator::TYPE_INTEGER,
@@ -153,6 +167,11 @@ public function withHttpCode(int $http_code = null): self
         return $this;
     }
 
+    /**
+     * @param null $data
+     *
+     * @return $this
+     */
     public function withData($data = null): self
     {
         Validator::assertIsType('data', $data, [Validator::TYPE_ARRAY,
@@ -163,6 +182,11 @@ public function withData($data = null): self
         return $this;
     }
 
+    /**
+     * @param int|null $json_opts
+     *
+     * @return $this
+     */
     public function withJsonOptions(int $json_opts = null): self
     {
         Validator::assertIsType('json_opts', $json_opts, [Validator::TYPE_INTEGER,
@@ -172,6 +196,11 @@ public function withJsonOptions(int $json_opts = null): self
         return $this;
     }
 
+    /**
+     * @param array|null $debug_data
+     *
+     * @return $this
+     */
     public function withDebugData(array $debug_data = null): self
     {
         Validator::assertIsType('$debug_data', $debug_data, [Validator::TYPE_ARRAY,
@@ -181,6 +210,11 @@ public function withDebugData(array $debug_data = null): self
         return $this;
     }
 
+    /**
+     * @param string|null $msg
+     *
+     * @return $this
+     */
     public function withMessage(string $msg = null): self
     {
         Validator::assertIsType('message', $msg, [Validator::TYPE_STRING,
@@ -190,20 +224,37 @@ public function withMessage(string $msg = null): self
         return $this;
     }
 
+    /**
+     * @param array|null $placeholders
+     *
+     * @return $this
+     */
     public function withPlaceholders(array $placeholders = null): self
     {
         $this->placeholders = $placeholders;
 
         return $this;
     }
 
+    /**
+     * @param array|null $http_headers
+     *
+     * @return $this
+     */
     public function withHttpHeaders(array $http_headers = null): self
     {
         $this->http_headers = $http_headers ?? [];
 
         return $this;
     }
 
+    /**
+     * Builds and returns final HttpResponse. It's safe to call build() as many times as needed, as no
+     * internal state is changed. It's also safe to alter any parameter set previously and call build()
+     * again to get new response object that includes new changes.
+     *
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
     public function build(): HttpResponse
     {
         $api_code = $this->api_code;