Add package API docblocks

Author: stevebauman

src/Engine.php

@@ -19,6 +19,9 @@
 use Laravel\Scout\Engines\Engine as ScoutEngine;
 use stdClass;
 
+/**
+ * Laravel Scout engine backed by OpenSearch.
+ */
 class Engine extends ScoutEngine
 {
     /**

src/Factories/DocumentFactory.php

@@ -8,6 +8,9 @@
 use Illuminate\Support\Collection;
 use UnexpectedValueException;
 
+/**
+ * Creates OpenSearch documents from Scout models.
+ */
 class DocumentFactory implements DocumentFactoryInterface
 {
     /**

src/Factories/DocumentFactoryInterface.php

@@ -4,6 +4,9 @@
 
 use Illuminate\Support\Collection;
 
+/**
+ * Defines a factory for creating OpenSearch documents from Scout models.
+ */
 interface DocumentFactoryInterface
 {
     /**

src/Factories/ModelFactory.php

@@ -9,6 +9,9 @@
 use Illuminate\Support\LazyCollection;
 use Laravel\Scout\Builder;
 
+/**
+ * Creates Scout model results from OpenSearch responses.
+ */
 class ModelFactory implements ModelFactoryInterface
 {
     /**

src/Factories/ModelFactoryInterface.php

@@ -7,6 +7,9 @@
 use Illuminate\Support\LazyCollection;
 use Laravel\Scout\Builder;
 
+/**
+ * Defines a factory for creating Scout model results from OpenSearch responses.
+ */
 interface ModelFactoryInterface
 {
     /**

src/Factories/SearchRequestFactory.php

@@ -7,6 +7,9 @@
 use Laravel\Scout\Builder;
 use stdClass;
 
+/**
+ * Creates OpenSearch search requests from Scout builders.
+ */
 class SearchRequestFactory implements SearchRequestFactoryInterface
 {
     /**

src/Factories/SearchRequestFactoryInterface.php

@@ -5,6 +5,9 @@
 use DirectoryTree\OpenSearchScoutDriver\SearchRequest;
 use Laravel\Scout\Builder;
 
+/**
+ * Defines a factory for creating OpenSearch search requests from Scout builders.
+ */
 interface SearchRequestFactoryInterface
 {
     /**

src/OpenSearchScoutServiceProvider.php

@@ -14,6 +14,9 @@
 use Illuminate\Support\ServiceProvider;
 use Laravel\Scout\EngineManager;
 
+/**
+ * Registers the OpenSearch Scout driver package.
+ */
 class OpenSearchScoutServiceProvider extends ServiceProvider
 {
     /**

src/SearchRequest.php

@@ -4,6 +4,9 @@
 
 use DirectoryTree\OpenSearchAdapter\Search\SearchRequest as OpenSearchRequest;
 
+/**
+ * Represents a Scout search request prepared for OpenSearch.
+ */
 class SearchRequest
 {
     /**