From b7774da1956ebc2f2fda48feb2617db824726a70 Mon Sep 17 00:00:00 2001
From: Ramesh Sencha <ramesh.sencha@perforce.com>
Date: Fri, 5 Jul 2024 14:11:34 +0530
Subject: [PATCH] (MAINT) Fixing documentation syntax of innobackup function

---
 .../functions/mysql/innobackupex_args.rb      | 22 +++++++++++--------
 1 file changed, 13 insertions(+), 9 deletions(-)

diff --git a/lib/puppet/functions/mysql/innobackupex_args.rb b/lib/puppet/functions/mysql/innobackupex_args.rb
index e9cc12064..fcad9ebc4 100644
--- a/lib/puppet/functions/mysql/innobackupex_args.rb
+++ b/lib/puppet/functions/mysql/innobackupex_args.rb
@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
-# @summary this function populates and returns the string of arguments which later gets injected in template.
-# arguments that return string holds is conditional and decided by the the input given to function.
-
+# @summary
+#   This function populates and returns the string of arguments which later gets injected in template. Arguments that return string holds is conditional and decided by the the input given to function.
+#
 Puppet::Functions.create_function(:'mysql::innobackupex_args') do
-  # @param args
-  #   String backupuser
-  #   Boolean backupcompress
-  #   String backuppassword_unsensitive
-  #   Array backupdatabases
-  #   Array optional_args
+  # @param backupuser
+  #   The user to use for the backup.
+  # @param backupcompress
+  #   If the backup should be compressed.
+  # @param backuppassword_unsensitive
+  #   The password to use for the backup.
+  # @param backupdatabases
+  #   The databases to backup.
+  # @param optional_args
+  #   Additional arguments to pass to innobackupex.
   #
   # @return String
   #   Generated on the basis of provided values.