Mark init() DocBlocks for internal use (#1047)

Co-authored-by: Markus Kalkbrenner <git@kalki.de>

Author: thomascorthals

src/Component/DistributedSearch.php

@@ -377,8 +377,8 @@ public function getReplicas(): array
     /**
      * Initialize options.
      *
-     * Several options need some extra checks or setup work, for these options
-     * the setters are called.
+     * {@internal Several options need some extra checks or setup work,
+     *            for these options the setters are called.}
      */
     protected function init()
     {

src/Component/Facet/AbstractRange.php

@@ -290,8 +290,8 @@ public function getPivot()
     /**
      * Initialize options.
      *
-     * Several options need some extra checks or setup work, for these options
-     * the setters are called.
+     * {@internal Several options need some extra checks or setup work,
+     *            for these options the setters are called.}
      */
     protected function init()
     {

src/Component/Facet/Interval.php

@@ -92,8 +92,8 @@ public function getSet(): array
     /**
      * Initialize options.
      *
-     * Several options need some extra checks or setup work, for these options
-     * the setters are called.
+     * {@internal Several options need some extra checks or setup work,
+     *            for these options the setters are called.}
      */
     protected function init()
     {

src/Component/Facet/JsonRange.php

@@ -35,8 +35,8 @@ public function getType(): string
     /**
      * Initialize options.
      *
-     * Several options need some extra checks or setup work, for these options
-     * the setters are called.
+     * {@internal Both the parent's and JsonFacetTrait's init() are needed
+     *            to properly initialize all options.}
      */
     protected function init()
     {

src/Component/Facet/MultiQuery.php

@@ -279,8 +279,7 @@ public function clearExcludes(): AbstractFacet
     /**
      * Initialize options.
      *
-     * Several options need some extra checks or setup work, for these options
-     * the setters are called.
+     * {@internal The 'query' option needs additional setup work.}
      */
     protected function init()
     {

src/Component/Facet/Pivot.php

@@ -405,6 +405,9 @@ public function setStats(array $stats): self
 
     /**
      * Initialize options.
+     *
+     * {@internal Options that set a list of fields need additional setup work
+     *            because they can be an array or a comma separated string.}
      */
     protected function init()
     {

src/Component/Facet/Range.php

@@ -55,8 +55,8 @@ public function getMinCount(): ?int
     /**
      * Initialize options.
      *
-     * Several options need some extra checks or setup work, for these options
-     * the setters are called.
+     * {@internal Several options need some extra checks or setup work,
+     *            for these options the setters are called.}
      */
     protected function init()
     {

src/Component/FacetSetTrait.php

@@ -196,8 +196,7 @@ public function createFacet(string $type, $options = null, bool $add = true): Fa
     /**
      * Initialize options.
      *
-     * Several options need some extra checks or setup work, for these options
-     * the setters are called.
+     * {@internal The 'facet' option needs additional setup work.}
      */
     protected function init()
     {

src/Component/Grouping.php

@@ -571,8 +571,9 @@ public function getResultValueGroupClass(): ?string
     /**
      * Initialize options.
      *
-     * Several options need some extra checks or setup work, for these options
-     * the setters are called.
+     * {@internal The 'query' option needs additional setup work.
+     *            Options that set a list of fields need additional setup work
+     *            because they can be an array or a comma separated string.}
      */
     protected function init()
     {

src/Component/Highlighting/Highlighting.php

@@ -280,7 +280,8 @@ public function getQueryFieldPattern(): ?array
     /**
      * Initialize options.
      *
-     * Options that can be an array or string with fieldnames need work.
+     * {@internal Options that set a list of fields need additional setup work
+     *            because they can be an array or a comma separated string.}
      */
     protected function init()
     {