Updated API docs

Firesphere · Dec 21, 2019 · c133111 · c133111
1 parent 7949fe8
commit c133111
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/Traits/IndexTraits/SolrIndexTrait.php b/src/Traits/IndexTraits/SolrIndexTrait.php
@@ -68,6 +68,8 @@ public function setDebug(bool $debug): self
     }
 
     /**
+     * Get the Index class.
+     *
      * @return BaseIndex
      */
     public function getIndex(): BaseIndex
@@ -76,6 +78,8 @@ public function getIndex(): BaseIndex
     }
 
     /**
+     * Set the index class
+     *
      * @param BaseIndex $index
      */
     public function setIndex(BaseIndex $index): void
@@ -84,6 +88,8 @@ public function setIndex(BaseIndex $index): void
     }
 
     /**
+     * Get the amount of CPU Cores configured
+     *
      * @return int
      */
     public function getCores(): int
@@ -92,6 +98,8 @@ public function getCores(): int
     }
 
     /**
+     * Set the amount of CPU Cores to use
+     *
      * @param int $cores
      */
     public function setCores(int $cores): void
@@ -100,6 +108,8 @@ public function setCores(int $cores): void
     }
 
     /**
+     * Get the length of a single batch
+     *
      * @return int
      */
     public function getBatchLength(): int
@@ -108,6 +118,8 @@ public function getBatchLength(): int
     }
 
     /**
+     * Set the length of a single batch
+     *
      * @param int $batchLength
      */
     public function setBatchLength(int $batchLength): void