Skip to content

Commit 6ffaba3

Browse files
authored
Merge pull request #1635 from puppetlabs/fix-reference-generator
(MAINT) Fixing documentation syntax of innobackup function
2 parents c9c41e8 + b7774da commit 6ffaba3

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

lib/puppet/functions/mysql/innobackupex_args.rb

+13-9
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
# frozen_string_literal: true
22

3-
# @summary this function populates and returns the string of arguments which later gets injected in template.
4-
# arguments that return string holds is conditional and decided by the the input given to function.
5-
3+
# @summary
4+
# 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.
5+
#
66
Puppet::Functions.create_function(:'mysql::innobackupex_args') do
7-
# @param args
8-
# String backupuser
9-
# Boolean backupcompress
10-
# String backuppassword_unsensitive
11-
# Array backupdatabases
12-
# Array optional_args
7+
# @param backupuser
8+
# The user to use for the backup.
9+
# @param backupcompress
10+
# If the backup should be compressed.
11+
# @param backuppassword_unsensitive
12+
# The password to use for the backup.
13+
# @param backupdatabases
14+
# The databases to backup.
15+
# @param optional_args
16+
# Additional arguments to pass to innobackupex.
1317
#
1418
# @return String
1519
# Generated on the basis of provided values.

0 commit comments

Comments
 (0)