Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / has_ip_network.rb
index 9ccf902..b4a3bad 100644 (file)
@@ -1,24 +1,25 @@
 #
 # has_ip_network
 #
-
 module Puppet::Parser::Functions
-  newfunction(:has_ip_network, :type => :rvalue, :doc => <<-EOS
-Returns true if the client has an IP address within the requested network.
+  newfunction(:has_ip_network, :type => :rvalue, :doc => <<-DOC
+    @summary
+      Returns true if the client has an IP address within the requested network.
+
+    @return
+      Boolean value, `true` if the client has an IP address within the requested network.
 
-This function iterates through the 'interfaces' fact and checks the
-'network_IFACE' facts, performing a simple string comparision.
-    EOS
-  ) do |args|
+    This function iterates through the 'interfaces' fact and checks the
+    'network_IFACE' facts, performing a simple string comparision.
+    DOC
+             ) do |args|
 
-    raise(Puppet::ParseError, "has_ip_network(): Wrong number of arguments " +
-          "given (#{args.size} for 1)") if args.size != 1
+    raise(Puppet::ParseError, "has_ip_network(): 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(['network', args[0]])
-
   end
 end