Update stdlib and concat to 6.1.0 both

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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_email_address.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_email_address.rb
index ddd0d25..5ad983a 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_email_address.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_email_address.rb
@@ -1,16 +1,28 @@
+#
+# validate_email_address.rb
+#
 module Puppet::Parser::Functions
-  newfunction(:validate_email_address, :doc => <<-ENDHEREDOC
-    Validate that all values passed are valid email addresses.
-    Fail compilation if any value fails this check.
-    The following values will pass:
-    $my_email = "waldo@gmail.com"
-    validate_email_address($my_email)
-    validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email)
-
-    The following values will fail, causing compilation to abort:
-    $some_array = [ 'bad_email@/d/efdf.com' ]
-    validate_email_address($some_array)
-    ENDHEREDOC
+  newfunction(:validate_email_address, :doc => <<-DOC
+    @summary
+      Validate that all values passed are valid email addresses.
+      Fail compilation if any value fails this check.
+
+    @return
+      Fail compilation if any value fails this check.
+
+    @example **Usage**
+
+      The following values will pass:
+
+        $my_email = "waldo@gmail.com"
+        validate_email_address($my_email)
+        validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email)
+
+      The following values will fail, causing compilation to abort:
+
+        $some_array = [ 'bad_email@/d/efdf.com' ]
+        validate_email_address($some_array)
+    DOC
              ) do |args|
     rescuable_exceptions = [ArgumentError]