📝 Add docstrings to feature/scout-trashed

Docstrings generation was requested by @GautierDele.

* #186 (comment)

The following files were modified:

* `src/Query/ScoutBuilder.php`
* `src/Rules/Search/SearchText.php`

Author: coderabbitai[bot]

src/Query/ScoutBuilder.php

@@ -118,9 +118,12 @@ public function sort($field, $direction = 'asc')
     }
 
     /**
-     * Apply multiple sorts to the query builder.
+     * Apply multiple sort directives to the underlying query builder.
      *
-     * @param array $sorts An array of sorts to apply.
+     * Each element must be an array with a 'field' key and an optional 'direction' key
+     * (defaults to 'asc'); each directive is forwarded to sort().
+     *
+     * @param array $sorts Array of sort directives.
      */
     public function applySorts($sorts)
     {
@@ -129,6 +132,15 @@ public function applySorts($sorts)
         }
     }
 
+    /**
+     * Apply soft-delete visibility to the underlying Scout query builder.
+     *
+     * Sets the query to include only soft-deleted records when `$trashed` is `"only"`,
+     * or to include both deleted and non-deleted records when `$trashed` is `"with"`.
+     * Any other value is ignored (no change).
+     *
+     * @param string $trashed One of: "only" (only trashed), "with" (include trashed), or other (no-op).
+     */
     public function applyTrashed(string $trashed): void
     {
         if ($trashed === 'only') {

src/Rules/Search/SearchText.php

@@ -7,6 +7,19 @@
 
 class SearchText extends RestRule
 {
+    /**
+     * Build Laravel validation rules for a search input attribute.
+     *
+     * Returns rules that either prohibit the attribute when the resource is not model-searchable,
+     * or validate a nested search payload structure when searchable:
+     * - `<attribute>`: optionally present and must be an array.
+     * - `<attribute>.value`: nullable string (the search text).
+     * - `<attribute>.trashed`: must be one of `'with'` or `'only'`.
+     *
+     * @param string $attribute The root attribute name to validate (e.g. "search").
+     * @param mixed $value Unused by this rule builder; present to match the rule interface.
+     * @return array<string, array<int, mixed>> Laravel validation rules keyed by attribute path.
+     */
     public function buildValidationRules(string $attribute, mixed $value): array
     {
         if (!$this->resource->isModelSearchable()) {