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

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/to_json.rb b/3rdparty/modules/stdlib/lib/puppet/functions/to_json.rb
index 782d695bd..20d39e76f 100644
--- a/3rdparty/modules/stdlib/lib/puppet/functions/to_json.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/to_json.rb
@@ -1,4 +1,6 @@
-# Take a data structure and output it as JSON
+require 'json'
+# @summary
+#   Convert a data structure and output to JSON
 #
 # @example how to output JSON
 #   # output json to a file
@@ -7,10 +9,10 @@
 #       content => to_json($myhash),
 #     }
 #
-#
-require 'json'
-
 Puppet::Functions.create_function(:to_json) do
+  # @param data
+  #   data structure which needs to be converted into JSON
+  # @return converted data to json
   dispatch :to_json do
     param 'Any', :data
   end