Refs #40947, Modify function comments of validateSortParameter in RES…

…T.php.
NETivism · Sep 12, 2024 · 3433c70 · 3433c70
1 parent f2a73ae
commit 3433c70
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/CRM/Utils/REST.php b/CRM/Utils/REST.php
@@ -634,8 +634,10 @@ static function ajax() {
   /**
    * validate sort parameter
    *
-   * @param  $sort
-   * @return void
+   * @param string $sort The sort parameter to validate. Can be a single field
+   *                     or multiple fields separated by commas (`,`), optionally
+   *                     followed by ASC or DESC.
+   * @return boolean true if valid, else false
    */
   public static function validateSortParameter($sort) {
     if (empty($sort) || !is_string($sort)) {