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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_ipv4_address.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_ipv4_address.rb
index 0660abdf5..1f3223fab 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_ipv4_address.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_ipv4_address.rb
@@ -1,34 +1,41 @@
+#
+# validate_ipv4_address.rb
+#
 module Puppet::Parser::Functions
+  newfunction(:validate_ipv4_address, :doc => <<-DOC
+    @summary
+      Validate that all values passed are valid IPv4 addresses.
+      Fail compilation if any value fails this check.
 
-  newfunction(:validate_ipv4_address, :doc => <<-ENDHEREDOC
-    Validate that all values passed are valid IPv4 addresses.
-    Fail compilation if any value fails this check.
+    @return
+      passes when the given values are valid IPv4 addresses or raise an error when they are not and fails compilation
 
-    The following values will pass:
+    @example **Usage**
+      The following values will pass:
 
-    $my_ip = "1.2.3.4"
-    validate_ipv4_address($my_ip)
-    validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip)
+        $my_ip = "1.2.3.4"
+        validate_ipv4_address($my_ip)
+        validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip)
 
-    The following values will fail, causing compilation to abort:
+      The following values will fail, causing compilation to abort:
 
-    $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ]
-    validate_ipv4_address($some_array)
+        $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ]
+        validate_ipv4_address($some_array)
+    DOC
+             ) do |args|
 
-    ENDHEREDOC
-  ) do |args|
+    function_deprecation([:validate_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function,
+                            with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.'])
 
-    function_deprecation([:validate_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.'])
-
-    require "ipaddr"
-    rescuable_exceptions = [ ArgumentError ]
+    require 'ipaddr'
+    rescuable_exceptions = [ArgumentError]
 
     if defined?(IPAddr::InvalidAddressError)
       rescuable_exceptions << IPAddr::InvalidAddressError
     end
 
-    unless args.length > 0 then
-      raise Puppet::ParseError, ("validate_ipv4_address(): wrong number of arguments (#{args.length}; must be > 0)")
+    if args.empty?
+      raise Puppet::ParseError, "validate_ipv4_address(): wrong number of arguments (#{args.length}; must be > 0)"
     end
 
     args.each do |arg|
@@ -44,7 +51,5 @@ module Puppet::Parser::Functions
         raise Puppet::ParseError, "#{arg.inspect} is not a valid IPv4 address."
       end
     end
-
   end
-
 end