From 3433c7088d29bf9bfeeaeaf68b395d6bd1e48091 Mon Sep 17 00:00:00 2001
From: Chang Shu-Huai <junsuwhy@netivism.com.tw>
Date: Thu, 12 Sep 2024 13:03:30 +0800
Subject: [PATCH] Refs #40947, Modify function comments of
 validateSortParameter in REST.php.

---
 CRM/Utils/REST.php | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/CRM/Utils/REST.php b/CRM/Utils/REST.php
index b1fd83c60..6bc221871 100644
--- 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)) {