Update stdlib and concat to 6.1.0 both

[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / functions / validate_re.rb

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/validate_re.rb b/3rdparty/modules/stdlib/lib/puppet/functions/validate_re.rb
index d357aab..d1695df 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/functions/validate_re.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/validate_re.rb
@@ -1,4 +1,19 @@
+# @summary
+#  Perform validation of a string against one or more regular
+#  expressions.
+#
 Puppet::Functions.create_function(:validate_re) do
+  # @param scope
+  #   The main value that will be passed to the method
+  #
+  # @param args
+  #   Any additional values that are to be passed to the method
+  #   The first argument of this function should be a string to
+  #   test, and the second argument should be a stringified regular expression
+  #   (without the // delimiters) or an array of regular expressions
+  #
+  # @return [Boolean]
+  #   `true` or `false` returned from the called function.
   dispatch :deprecation_gen do
     param 'Any', :scope
     repeated_param 'Any', :args