X-Git-Url: https://git.adam-barratt.org.uk/?p=mirror%2Fdsa-puppet.git;a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Ffunctions%2Fvalidate_re.rb;h=d1695df564bb4fee8d228bdebbadfe57bbee367c;hp=d357aab31b701a9f602cab3a0605beacc3fa1bc4;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/validate_re.rb b/3rdparty/modules/stdlib/lib/puppet/functions/validate_re.rb
index d357aab31..d1695df56 100644
--- 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