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_string.rb;h=50b1dafbcc62d946c386ffade3802dac6ce968ea;hp=a908c19747a1d90c34c4bd147610dcd736cbced6;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/validate_string.rb b/3rdparty/modules/stdlib/lib/puppet/functions/validate_string.rb
index a908c1974..50b1dafbc 100644
--- a/3rdparty/modules/stdlib/lib/puppet/functions/validate_string.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/validate_string.rb
@@ -1,4 +1,14 @@
+# @summary
+#   Validate that all passed values are string data structures.
 Puppet::Functions.create_function(:validate_string) 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