* improved documentation

AbsaOSS · Oct 3, 2024 · 4e9e734 · 4e9e734
1 parent 843ddb8
commit 4e9e734
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/balta/src/main/scala/za/co/absa/db/balta/classes/DBFunction.scala b/balta/src/main/scala/za/co/absa/db/balta/classes/DBFunction.scala
@@ -57,6 +57,9 @@ sealed abstract class DBFunction private(functionName: String,
    * Executes the function without any verification procedure. It instantiates the function result(s) and returns them in
    * a list.
    * @param orderBy     - the clause how to order the function result, if empty, default ordering is preserved
+   *                    examples:
+   *                      * "product_id DESC"
+   *                      * "product_name, import_date DESC"
    * @param connection  - the database connection
    */
   def getResult(orderBy: String = "")(implicit connection: DBConnection): List[QueryResultRow] = {
@@ -79,6 +82,9 @@ sealed abstract class DBFunction private(functionName: String,
    *  Executes the function and verifies the result via the verify function.
    *
    * @param orderBy     - the clause how to order the function result
+   *                    examples:
+   *                      * "product_id DESC"
+   *                      * "product_name, import_date DESC"
    * @param verify      - the function that verifies the result
    * @param connection  - the database connection
    * @tparam R          - the type of the result that is returned by the verify function