X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fvalidate_email_address.rb;h=5ad983a30baad9e672b2fdd44b0c82f33827be6c;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=ddd0d25f1624d111ad3b68a61f962ad5a314ee3b;hpb=6963202b4b62c2816655ac9532521b018fdf83bd;p=mirror%2Fdsa-puppet.git

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 ddd0d25f1..5ad983a30 100644
--- 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]