refactor: update inline docs

alpheusmtx · alpheusmtx · commit b985346d0740 · 2025-12-23T16:55:41.000+08:00
diff --git a/src/Base/CreateResponseBase.php b/src/Base/CreateResponseBase.php
@@ -7,7 +7,7 @@
 use Psr\Http\Message\ResponseInterface as Response;
 
 /**
- * @api
+ * Base class to create response.
  */
 class CreateResponseBase
 {
diff --git a/src/CreateResponse.php b/src/CreateResponse.php
@@ -10,8 +10,6 @@
 
 /**
  * Function to create response.
- *
- * @api
  */
 class CreateResponse extends CreateResponseBase
 {
diff --git a/src/Json/CreateJsonResponse.php b/src/Json/CreateJsonResponse.php
@@ -10,8 +10,6 @@
 
 /**
  * Function to create JSON response.
- *
- * @api
  */
 class CreateJsonResponse
 {
diff --git a/src/Json/Functions/Base/CreateJsonResponseFunctionBase.php b/src/Json/Functions/Base/CreateJsonResponseFunctionBase.php
@@ -11,7 +11,7 @@
 const FAILURE_RESPONSE_DEFAULT = "{\"success\":false,\"data\":null,\"errors\":[{\"code\":\"server\",\"path\":[],\"message\":\"Internal server error.\"}]}";
 
 /**
- * @api
+ * Base functions to create JSON response.
  */
 class CreateJsonResponseFunctionBase extends CreateResponseBase
 {
diff --git a/src/Json/Functions/CreateJsonFailureResponseFunctions.php b/src/Json/Functions/CreateJsonFailureResponseFunctions.php
@@ -9,7 +9,7 @@
 use Psr\Http\Message\ResponseInterface as Response;
 
 /**
- * @api
+ * Functions to create failure response in JSON.
  */
 class CreateJsonFailureResponseFunctions extends CreateJsonResponseFunctionBase
 {
diff --git a/src/Json/Functions/CreateJsonSuccessResponseFunctions.php b/src/Json/Functions/CreateJsonSuccessResponseFunctions.php
@@ -8,7 +8,7 @@
 use Psr\Http\Message\ResponseInterface as Response;
 
 /**
- * @api
+ * Functions to create success response in JSON.
  */
 class CreateJsonSuccessResponseFunctions extends CreateJsonResponseFunctionBase
 {
diff --git a/src/Json/JsonResponse.php b/src/Json/JsonResponse.php
@@ -11,8 +11,6 @@
 
 /**
  * JSON response.
- *
- * @api
  */
 class JsonResponse implements JsonSerializable
 {
diff --git a/src/Json/JsonResponseError.php b/src/Json/JsonResponseError.php
@@ -11,8 +11,6 @@
 
 /**
  * JSON response error.
- *
- * @api
  */
 class JsonResponseError implements JsonSerializable
 {
diff --git a/src/Json/ResponseErrorCode.php b/src/Json/ResponseErrorCode.php
@@ -6,8 +6,6 @@
 
 /**
  * Response error code.
- *
- * @api
  */
 enum ResponseErrorCode: string
 {

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`use Psr\Http\Message\ResponseInterface as Response;`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * @api`
	`10`	`+ * Base class to create response.`
`11`	`11`	`*/`
`12`	`12`	`class CreateResponseBase`
`13`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,6 @@`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`* Function to create response.`
`13`		`- *`
`14`		`- * @api`
`15`	`13`	`*/`
`16`	`14`	`class CreateResponse extends CreateResponseBase`
`17`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`const FAILURE_RESPONSE_DEFAULT = "{\"success\":false,\"data\":null,\"errors\":[{\"code\":\"server\",\"path\":[],\"message\":\"Internal server error.\"}]}";`
`12`	`12`
`13`	`13`	`/**`
`14`		`- * @api`
	`14`	`+ * Base functions to create JSON response.`
`15`	`15`	`*/`
`16`	`16`	`class CreateJsonResponseFunctionBase extends CreateResponseBase`
`17`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`use Psr\Http\Message\ResponseInterface as Response;`
`10`	`10`
`11`	`11`	`/**`
`12`		`- * @api`
	`12`	`+ * Functions to create failure response in JSON.`
`13`	`13`	`*/`
`14`	`14`	`class CreateJsonFailureResponseFunctions extends CreateJsonResponseFunctionBase`
`15`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`use Psr\Http\Message\ResponseInterface as Response;`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * @api`
	`11`	`+ * Functions to create success response in JSON.`
`12`	`12`	`*/`
`13`	`13`	`class CreateJsonSuccessResponseFunctions extends CreateJsonResponseFunctionBase`
`14`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,6 @@`
`11`	`11`
`12`	`12`	`/**`
`13`	`13`	`* JSON response.`
`14`		`- *`
`15`		`- * @api`
`16`	`14`	`*/`
`17`	`15`	`class JsonResponse implements JsonSerializable`
`18`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,6 @@`
`6`	`6`
`7`	`7`	`/**`
`8`	`8`	`* Response error code.`
`9`		`- *`
`10`		`- * @api`
`11`	`9`	`*/`
`12`	`10`	`enum ResponseErrorCode: string`
`13`	`11`	`{`