Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / has_ip_address.rb
index 842c8ec..4004681 100644 (file)
@@ -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