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_legacy.rb;h=1e1621924b41c527685b8c42537d34e7f3eff98f;hp=21646ade3ad08cc52bbedd096def28beba95e198;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/validate_legacy.rb b/3rdparty/modules/stdlib/lib/puppet/functions/validate_legacy.rb
index 21646ade3..1e1621924 100644
--- a/3rdparty/modules/stdlib/lib/puppet/functions/validate_legacy.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/validate_legacy.rb
@@ -1,6 +1,16 @@
+# @summary
+#   Validate a value against both the target_type (new) and the previous_validation function (old).
 Puppet::Functions.create_function(:validate_legacy) do
   # The function checks a value against both the target_type (new) and the previous_validation function (old).
-
+  # @param scope
+  #   The main value that will be passed to the method
+  # @param target_type
+  # @param function_name
+  # @param value
+  # @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 :validate_legacy do
     param 'Any', :scope
     param 'Type', :target_type
@@ -9,6 +19,14 @@ Puppet::Functions.create_function(:validate_legacy) do
     repeated_param 'Any', :args
   end
 
+  # @param scope
+  #   The main value that will be passed to the method
+  # @param type_string
+  # @param function_name
+  # @param value
+  # @param args Any additional values that are to be passed to the method
+  # @return Legacy validation method
+  #
   dispatch :validate_legacy_s do
     param 'Any', :scope
     param 'String', :type_string