refactor: uses inheritDoct to reduce redundancy

JasonTheAdams · JasonTheAdams · commit 9875f8446701 · 2025-07-22T08:57:32.000-06:00
diff --git a/src/Files/DTO/InlineFile.php b/src/Files/DTO/InlineFile.php
@@ -63,10 +63,9 @@ public function getBase64Data(): string
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Files/DTO/LocalFile.php b/src/Files/DTO/LocalFile.php
@@ -63,10 +63,9 @@ public function getPath(): string
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Files/DTO/RemoteFile.php b/src/Files/DTO/RemoteFile.php
@@ -63,10 +63,9 @@ public function getUrl(): string
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Messages/DTO/Message.php b/src/Messages/DTO/Message.php
@@ -76,10 +76,9 @@ public function getParts(): array
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Messages/DTO/MessagePart.php b/src/Messages/DTO/MessagePart.php
@@ -199,10 +199,9 @@ public function getFunctionResponse(): ?FunctionResponse
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Operations/DTO/EmbeddingOperation.php b/src/Operations/DTO/EmbeddingOperation.php
@@ -49,21 +49,19 @@ public function __construct(string $id, OperationStateEnum $state, ?EmbeddingRes
     }
 
     /**
-     * Get the operation ID
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return string The unique identifier
      */
     public function getId(): string
     {
         return $this->id;
     }
 
     /**
-     * Get the current state of the operation
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return OperationStateEnum The operation state
      */
     public function getState(): OperationStateEnum
     {
@@ -82,10 +80,9 @@ public function getResult(): ?EmbeddingResult
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Operations/DTO/GenerativeAiOperation.php b/src/Operations/DTO/GenerativeAiOperation.php
@@ -49,21 +49,19 @@ public function __construct(string $id, OperationStateEnum $state, ?GenerativeAi
     }
 
     /**
-     * Get the operation ID
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return string The unique identifier
      */
     public function getId(): string
     {
         return $this->id;
     }
 
     /**
-     * Get the current state of the operation
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return OperationStateEnum The operation state
      */
     public function getState(): OperationStateEnum
     {
@@ -82,10 +80,9 @@ public function getResult(): ?GenerativeAiResult
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Results/DTO/Candidate.php b/src/Results/DTO/Candidate.php
@@ -82,10 +82,9 @@ public function getTokenCount(): int
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Results/DTO/EmbeddingResult.php b/src/Results/DTO/EmbeddingResult.php
@@ -55,10 +55,9 @@ public function __construct(string $id, array $embeddings, TokenUsage $tokenUsag
     }
 
     /**
-     * Get the result ID
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return string The unique identifier
      */
     public function getId(): string
     {
@@ -77,32 +76,29 @@ public function getEmbeddings(): array
     }
 
     /**
-     * Get token usage information
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return TokenUsage Token usage statistics
      */
     public function getTokenUsage(): TokenUsage
     {
         return $this->tokenUsage;
     }
 
     /**
-     * Get provider-specific metadata
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> Provider metadata
      */
     public function getProviderMetadata(): array
     {
         return $this->providerMetadata;
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Results/DTO/GenerativeAiResult.php b/src/Results/DTO/GenerativeAiResult.php
@@ -57,10 +57,9 @@ public function __construct(string $id, array $candidates, TokenUsage $tokenUsag
     }
 
     /**
-     * Get the result ID
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return string The unique identifier
      */
     public function getId(): string
     {
@@ -79,21 +78,19 @@ public function getCandidates(): array
     }
 
     /**
-     * Get token usage information
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return TokenUsage Token usage statistics
      */
     public function getTokenUsage(): TokenUsage
     {
         return $this->tokenUsage;
     }
 
     /**
-     * Get provider-specific metadata
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> Provider metadata
      */
     public function getProviderMetadata(): array
     {
@@ -273,10 +270,9 @@ public function toMessages(): array
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Results/DTO/TokenUsage.php b/src/Results/DTO/TokenUsage.php
@@ -80,10 +80,9 @@ public function getTotalTokens(): int
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Tools/DTO/FunctionCall.php b/src/Tools/DTO/FunctionCall.php
@@ -80,10 +80,9 @@ public function getArgs(): array
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Tools/DTO/FunctionDeclaration.php b/src/Tools/DTO/FunctionDeclaration.php
@@ -80,10 +80,9 @@ public function getParameters()
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Tools/DTO/FunctionResponse.php b/src/Tools/DTO/FunctionResponse.php
@@ -80,10 +80,9 @@ public function getResponse()
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Tools/DTO/Tool.php b/src/Tools/DTO/Tool.php
@@ -105,10 +105,9 @@ public function getWebSearch(): ?WebSearch
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {
diff --git a/src/Tools/DTO/WebSearch.php b/src/Tools/DTO/WebSearch.php
@@ -62,10 +62,9 @@ public function getDisallowedDomains(): array
     }
 
     /**
-     * Get the JSON schema for this DTO
+     * {@inheritDoc}
      *
      * @since n.e.x.t
-     * @return array<string, mixed> The JSON schema
      */
     public static function getJsonSchema(): array
     {

Original file line number	Diff line number	Diff line change
`@@ -63,10 +63,9 @@ public function getBase64Data(): string`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`/**`
`66`		`- * Get the JSON schema for this DTO`
	`66`	`+ * {@inheritDoc}`
`67`	`67`	`*`
`68`	`68`	`* @since n.e.x.t`
`69`		`- * @return array<string, mixed> The JSON schema`
`70`	`69`	`*/`
`71`	`70`	`public static function getJsonSchema(): array`
`72`	`71`	`{`
Original file line number	Diff line number	Diff line change
`@@ -63,10 +63,9 @@ public function getPath(): string`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`/**`
`66`		`- * Get the JSON schema for this DTO`
	`66`	`+ * {@inheritDoc}`
`67`	`67`	`*`
`68`	`68`	`* @since n.e.x.t`
`69`		`- * @return array<string, mixed> The JSON schema`
`70`	`69`	`*/`
`71`	`70`	`public static function getJsonSchema(): array`
`72`	`71`	`{`
Original file line number	Diff line number	Diff line change
`@@ -63,10 +63,9 @@ public function getUrl(): string`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`/**`
`66`		`- * Get the JSON schema for this DTO`
	`66`	`+ * {@inheritDoc}`
`67`	`67`	`*`
`68`	`68`	`* @since n.e.x.t`
`69`		`- * @return array<string, mixed> The JSON schema`
`70`	`69`	`*/`
`71`	`70`	`public static function getJsonSchema(): array`
`72`	`71`	`{`
Original file line number	Diff line number	Diff line change
`@@ -76,10 +76,9 @@ public function getParts(): array`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`/**`
`79`		`- * Get the JSON schema for this DTO`
	`79`	`+ * {@inheritDoc}`
`80`	`80`	`*`
`81`	`81`	`* @since n.e.x.t`
`82`		`- * @return array<string, mixed> The JSON schema`
`83`	`82`	`*/`
`84`	`83`	`public static function getJsonSchema(): array`
`85`	`84`	`{`
Original file line number	Diff line number	Diff line change
`@@ -199,10 +199,9 @@ public function getFunctionResponse(): ?FunctionResponse`
`199`	`199`	`}`
`200`	`200`
`201`	`201`	`/**`
`202`		`- * Get the JSON schema for this DTO`
	`202`	`+ * {@inheritDoc}`
`203`	`203`	`*`
`204`	`204`	`* @since n.e.x.t`
`205`		`- * @return array<string, mixed> The JSON schema`
`206`	`205`	`*/`
`207`	`206`	`public static function getJsonSchema(): array`
`208`	`207`	`{`
Original file line number	Diff line number	Diff line change
`@@ -49,21 +49,19 @@ public function __construct(string $id, OperationStateEnum $state, ?EmbeddingRes`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`/**`
`52`		`- * Get the operation ID`
	`52`	`+ * {@inheritDoc}`
`53`	`53`	`*`
`54`	`54`	`* @since n.e.x.t`
`55`		`- * @return string The unique identifier`
`56`	`55`	`*/`
`57`	`56`	`public function getId(): string`
`58`	`57`	`{`
`59`	`58`	`return $this->id;`
`60`	`59`	`}`
`61`	`60`
`62`	`61`	`/**`
`63`		`- * Get the current state of the operation`
	`62`	`+ * {@inheritDoc}`
`64`	`63`	`*`
`65`	`64`	`* @since n.e.x.t`
`66`		`- * @return OperationStateEnum The operation state`
`67`	`65`	`*/`
`68`	`66`	`public function getState(): OperationStateEnum`
`69`	`67`	`{`
`@@ -82,10 +80,9 @@ public function getResult(): ?EmbeddingResult`
`82`	`80`	`}`
`83`	`81`
`84`	`82`	`/**`
`85`		`- * Get the JSON schema for this DTO`
	`83`	`+ * {@inheritDoc}`
`86`	`84`	`*`
`87`	`85`	`* @since n.e.x.t`
`88`		`- * @return array<string, mixed> The JSON schema`
`89`	`86`	`*/`
`90`	`87`	`public static function getJsonSchema(): array`
`91`	`88`	`{`
Original file line number	Diff line number	Diff line change
`@@ -82,10 +82,9 @@ public function getTokenCount(): int`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`/**`
`85`		`- * Get the JSON schema for this DTO`
	`85`	`+ * {@inheritDoc}`
`86`	`86`	`*`
`87`	`87`	`* @since n.e.x.t`
`88`		`- * @return array<string, mixed> The JSON schema`
`89`	`88`	`*/`
`90`	`89`	`public static function getJsonSchema(): array`
`91`	`90`	`{`
Original file line number	Diff line number	Diff line change
`@@ -55,10 +55,9 @@ public function __construct(string $id, array $embeddings, TokenUsage $tokenUsag`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`/**`
`58`		`- * Get the result ID`
	`58`	`+ * {@inheritDoc}`
`59`	`59`	`*`
`60`	`60`	`* @since n.e.x.t`
`61`		`- * @return string The unique identifier`
`62`	`61`	`*/`
`63`	`62`	`public function getId(): string`
`64`	`63`	`{`
`@@ -77,32 +76,29 @@ public function getEmbeddings(): array`
`77`	`76`	`}`
`78`	`77`
`79`	`78`	`/**`
`80`		`- * Get token usage information`
	`79`	`+ * {@inheritDoc}`
`81`	`80`	`*`
`82`	`81`	`* @since n.e.x.t`
`83`		`- * @return TokenUsage Token usage statistics`
`84`	`82`	`*/`
`85`	`83`	`public function getTokenUsage(): TokenUsage`
`86`	`84`	`{`
`87`	`85`	`return $this->tokenUsage;`
`88`	`86`	`}`
`89`	`87`
`90`	`88`	`/**`
`91`		`- * Get provider-specific metadata`
	`89`	`+ * {@inheritDoc}`
`92`	`90`	`*`
`93`	`91`	`* @since n.e.x.t`
`94`		`- * @return array<string, mixed> Provider metadata`
`95`	`92`	`*/`
`96`	`93`	`public function getProviderMetadata(): array`
`97`	`94`	`{`
`98`	`95`	`return $this->providerMetadata;`
`99`	`96`	`}`
`100`	`97`
`101`	`98`	`/**`
`102`		`- * Get the JSON schema for this DTO`
	`99`	`+ * {@inheritDoc}`
`103`	`100`	`*`
`104`	`101`	`* @since n.e.x.t`
`105`		`- * @return array<string, mixed> The JSON schema`
`106`	`102`	`*/`
`107`	`103`	`public static function getJsonSchema(): array`
`108`	`104`	`{`
Original file line number	Diff line number	Diff line change
`@@ -57,10 +57,9 @@ public function __construct(string $id, array $candidates, TokenUsage $tokenUsag`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`/**`
`60`		`- * Get the result ID`
	`60`	`+ * {@inheritDoc}`
`61`	`61`	`*`
`62`	`62`	`* @since n.e.x.t`
`63`		`- * @return string The unique identifier`
`64`	`63`	`*/`
`65`	`64`	`public function getId(): string`
`66`	`65`	`{`
`@@ -79,21 +78,19 @@ public function getCandidates(): array`
`79`	`78`	`}`
`80`	`79`
`81`	`80`	`/**`
`82`		`- * Get token usage information`
	`81`	`+ * {@inheritDoc}`
`83`	`82`	`*`
`84`	`83`	`* @since n.e.x.t`
`85`		`- * @return TokenUsage Token usage statistics`
`86`	`84`	`*/`
`87`	`85`	`public function getTokenUsage(): TokenUsage`
`88`	`86`	`{`
`89`	`87`	`return $this->tokenUsage;`
`90`	`88`	`}`
`91`	`89`
`92`	`90`	`/**`
`93`		`- * Get provider-specific metadata`
	`91`	`+ * {@inheritDoc}`
`94`	`92`	`*`
`95`	`93`	`* @since n.e.x.t`
`96`		`- * @return array<string, mixed> Provider metadata`
`97`	`94`	`*/`
`98`	`95`	`public function getProviderMetadata(): array`
`99`	`96`	`{`
`@@ -273,10 +270,9 @@ public function toMessages(): array`
`273`	`270`	`}`
`274`	`271`
`275`	`272`	`/**`
`276`		`- * Get the JSON schema for this DTO`
	`273`	`+ * {@inheritDoc}`
`277`	`274`	`*`
`278`	`275`	`* @since n.e.x.t`
`279`		`- * @return array<string, mixed> The JSON schema`
`280`	`276`	`*/`
`281`	`277`	`public static function getJsonSchema(): array`
`282`	`278`	`{`