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

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/is_ip_address.rb b/3rdparty/modules/stdlib/lib/puppet/functions/is_ip_address.rb
index 4c72037fc..92e556461 100644
--- a/3rdparty/modules/stdlib/lib/puppet/functions/is_ip_address.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/is_ip_address.rb
@@ -1,15 +1,27 @@
+# @summary
+#   Wrapper that calls the Puppet 3.x funtion of the same name.
 Puppet::Functions.create_function(:is_ip_address) do
+  # @param scope
+  #   The main value that will be passed to the wrapped method
+  #
+  # @param args
+  #   Any additional values that are to be passed to the wrapped method
+  #
+  # @return [Boolea]
+  #   A boolean value returned from the called 3.x function.
   dispatch :deprecation_gen do
     param 'Any', :scope
     repeated_param 'Any', :args
   end
-  # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1.
+  # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff
+  #   -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1.
   def call(scope, *args)
     manipulated_args = [scope] + args
     self.class.dispatcher.dispatch(self, scope, manipulated_args)
   end
+
   def deprecation_gen(scope, *args)
-    call_function('deprecation', 'is_ip_address', "This method is deprecated, please use match expressions with Stdlib::Compat::Ip_address instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.")
-    scope.send("function_is_ip_address", args)
+    call_function('deprecation', 'is_ip_address', 'This method is deprecated, please use match expressions with Stdlib::Compat::Ip_address instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.')
+    scope.send('function_is_ip_address', args)
   end
 end