groupby / api-php

src/API/Model/ResultsMetadata.php

Doc Comments +2 added lines, -2 removed lines

@@ -24,7 +24,7 @@ 
 
   /**
    * @param recordLimitReached    Whether the total record count is actually greater than the returned record count
-   * @return                      This ResultsMetadata object
+   * @return                      ResultsMetadata ResultsMetadata object
    */
   public function setRecordLimitReached($recordLimitReached)
   {
@@ -42,7 +42,7 @@ 
 
   /**
    * @param totalTime    The total time spent in milliseconds to generate results
-   * @return             This ResultsMetadata object
+   * @return             ResultsMetadata ResultsMetadata object
    */
   public function setTotalTime($totalTime)
   {

src/API/Model/NumericBoost.php

Doc Comments +6 added lines, -5 removed lines

@@ -30,8 +30,8 @@ 
   /**
    * Set the name of this Numeric Boost
    *
-   * @param name    The string to be the name of this Numeric Boost
-   * @return        This Numeric Boost
+   * @param name    string string to be the name of this Numeric Boost
+   * @return        NumericBoost Numeric Boost
    */
   public function setName($name)
   {
@@ -50,8 +50,8 @@ 
   /**
    * Set this Numeric Boost to inverted
    *
-   * @param inverted    True if this is to be an iverted Numeric Boost, false otherwise
-   * @return            This Numeric Boost
+   * @param inverted    boolean if this is to be an iverted Numeric Boost, false otherwise
+   * @return            NumericBoost Numeric Boost
    */
   public function setInverted($inverted)
   {
@@ -71,7 +71,8 @@ 
    * Set the strength of this Numeric Boost
    *
    * @param double  The value to be the strength of this Numeric Boost
-   * @return        This Numeric Boost
+   * @param double $strength
+   * @return        NumericBoost Numeric Boost
    */
   public function setStrength($strength)
   {

src/API/Query.php

Doc Comments +3 added lines

@@ -430,6 +430,9 @@
     array_push($this->customUrlParams, $param);
   }
 
+  /**
+   * @param string|null $refinementString
+   */
   public function splitRefinements($refinementString)
   {
     if (StringUtils::isNotBlank($refinementString)) {