diff modules/stdlib/lib/puppet/functions/validate_hash.rb @ 275:d9352a684e62

Mass update of modules to remove deprecation warnings
author IBBoard <dev@ibboard.co.uk>
date Sun, 26 Jan 2020 11:36:07 +0000
parents c42fb28cff86
children
line wrap: on
line diff
--- a/modules/stdlib/lib/puppet/functions/validate_hash.rb	Sat Jan 04 11:42:45 2020 +0000
+++ b/modules/stdlib/lib/puppet/functions/validate_hash.rb	Sun Jan 26 11:36:07 2020 +0000
@@ -1,4 +1,14 @@
+# @summary
+#   Validate the passed value represents a hash.
 Puppet::Functions.create_function(:validate_hash) 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
+  #   A boolean value (`true` or `false`) returned from the called function.
   dispatch :deprecation_gen do
     param 'Any', :scope
     repeated_param 'Any', :args