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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/parseyaml.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/parseyaml.rb
index 7f857ca8d..5d081e6a6 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/parseyaml.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/parseyaml.rb
@@ -3,11 +3,16 @@
 #
 module Puppet::Parser::Functions
   newfunction(:parseyaml, :type => :rvalue, :doc => <<-DOC
-    This function accepts YAML as a string and converts it into the correct
-    Puppet structure.
+    @summary
+      This function accepts YAML as a string and converts it into the correct
+      Puppet structure.
 
-    The optional second argument can be used to pass a default value that will
-    be returned if the parsing of YAML string have failed.
+    @return
+      converted YAML into Puppet structure
+
+    > *Note:*
+      The optional second argument can be used to pass a default value that will
+      be returned if the parsing of YAML string have failed.
   DOC
              ) do |arguments|
     raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1