X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fhas_ip_address.rb;h=4004681cafceb896375153a77224a0eb742598e8;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=842c8ec67438b8850ffa4289bcc34aae8b27f3c7;hpb=ad88f67c13ae0f1a08936dad643f1e3509ab5f40;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/has_ip_address.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/has_ip_address.rb
index 842c8ec67..4004681ca 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/has_ip_address.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/has_ip_address.rb
@@ -1,24 +1,25 @@
 #
 # has_ip_address
 #
-
 module Puppet::Parser::Functions
-  newfunction(:has_ip_address, :type => :rvalue, :doc => <<-EOS
-Returns true if the client has the requested IP address on some interface.
+  newfunction(:has_ip_address, :type => :rvalue, :doc => <<-DOC
+    @summary
+      Returns true if the client has the requested IP address on some interface.
+
+    @return [Boolean]
+      `true` or `false`
 
-This function iterates through the 'interfaces' fact and checks the
-'ipaddress_IFACE' facts, performing a simple string comparison.
-    EOS
-  ) do |args|
+    This function iterates through the 'interfaces' fact and checks the
+    'ipaddress_IFACE' facts, performing a simple string comparison.
+    DOC
+             ) do |args|
 
-    raise(Puppet::ParseError, "has_ip_address(): Wrong number of arguments " +
-          "given (#{args.size} for 1)") if args.size != 1
+    raise(Puppet::ParseError, "has_ip_address(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1
 
     Puppet::Parser::Functions.autoloader.load(:has_interface_with) \
       unless Puppet::Parser::Functions.autoloader.loaded?(:has_interface_with)
 
     function_has_interface_with(['ipaddress', args[0]])
-
   end
 end