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

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/deprecation.rb b/3rdparty/modules/stdlib/lib/puppet/functions/deprecation.rb
index af6109d9d..2f6b0c0ed 100644
--- a/3rdparty/modules/stdlib/lib/puppet/functions/deprecation.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/deprecation.rb
@@ -1,10 +1,16 @@
-# Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once.
-# The msg is the message text including any positional information that is formatted by the user/caller of the method.
-# It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message),
-#   :off (no message / error is displayed) and :warning (default, outputs a warning)  *Type*: String, String.
+#   Function to print deprecation warnings, Logs a warning once for a given key.
+#
+# The uniqueness key - can appear once.
+# The msg is the message text including any positional information that is formatted by the
+# user/caller of the method.
+# It is affected by the puppet setting 'strict', which can be set to :error
+# (outputs as an error message), :off (no message / error is displayed) and :warning
+# (default, outputs a warning)  *Type*: String, String.
 #
-
 Puppet::Functions.create_function(:deprecation) do
+  # @param key
+  # @param  message
+  # @return deprecated warnings
   dispatch :deprecation do
     param 'String', :key
     param 'String', :message