X-Git-Url: https://git.adam-barratt.org.uk/?p=mirror%2Fdsa-puppet.git;a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Ffunctions%2Fvalidate_ip_address.rb;h=233f083d4786d130951486c3863274e73ee3718a;hp=68e7f7f882d0b59eede28c60fc62da44a0bb6cf5;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/validate_ip_address.rb b/3rdparty/modules/stdlib/lib/puppet/functions/validate_ip_address.rb
index 68e7f7f88..233f083d4 100644
--- a/3rdparty/modules/stdlib/lib/puppet/functions/validate_ip_address.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/validate_ip_address.rb
@@ -1,4 +1,14 @@
+# @summary
+#   Validate the passed value represents an ip_address.
 Puppet::Functions.create_function(:validate_ip_address) do
+  # @param scope
+  #   The main value that will be passed to the method
+  #
+  # @param args
+  #   Any additional values that are to be passed to the method
+  #
+  # @return [Boolean] `true` or `false`
+  #   A boolean value returned from the called function.
   dispatch :deprecation_gen do
     param 'Any', :scope
     repeated_param 'Any', :args