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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_re.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_re.rb
index 88f23fcc7..14ad7abd4 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_re.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_re.rb
@@ -2,17 +2,23 @@
 # validate.rb
 #
 module Puppet::Parser::Functions
-  newfunction(:validate_re, :doc => <<-'DOC') do |args|
+  newfunction(:validate_re, :doc => <<-DOC
+  @summary
     Perform simple validation of a string against one or more regular
-    expressions. 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.  If none
-    of the regular expressions match the string passed in, compilation will
-    abort with a parse error.
+    expressions.
 
-    If a third argument is specified, this will be the error message raised and
-    seen by the user.
+  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.  If none
+  of the regular expressions match the string passed in, compilation will
+  abort with a parse error.
+  If a third argument is specified, this will be the error message raised and
+  seen by the user.
 
+  @return
+    validation of a string against one or more regular expressions.
+
+  @example **Usage**
     The following strings will validate against the regular expressions:
 
         validate_re('one', '^one$')
@@ -26,13 +32,12 @@ module Puppet::Parser::Functions
 
         validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7')
 
-    Note: Compilation will also abort, if the first argument is not a String. Always use
-    quotes to force stringification:
-
-        validate_re("${::operatingsystemmajrelease}", '^[57]$')
-
-    DOC
-
+  > *Note:*
+  Compilation will also abort, if the first argument is not a String. Always use
+  quotes to force stringification:
+  validate_re("${::operatingsystemmajrelease}", '^[57]$')
+   DOC
+             ) do |args|
     function_deprecation([:validate_re, 'This method is deprecated, please use the stdlib validate_legacy function,
                             with Stdlib::Compat::Re. There is further documentation for validate_legacy function in the README.'])