Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / parseyaml.rb
index 7f857ca..5d081e6 100644 (file)
@@ -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