Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / deep_merge.rb
index dd70c61..bf62576 100644 (file)
@@ -3,19 +3,23 @@
 #
 module Puppet::Parser::Functions
   newfunction(:deep_merge, :type => :rvalue, :doc => <<-'DOC') do |args|
-    Recursively merges two or more hashes together and returns the resulting hash.
+    @summary
+      Recursively merges two or more hashes together and returns the resulting hash.
 
-    For example:
+    @example Example usage
 
-        $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
-        $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
-        $merged_hash = deep_merge($hash1, $hash2)
-        # The resulting hash is equivalent to:
-        # $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } }
+      $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
+      $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
+      $merged_hash = deep_merge($hash1, $hash2)
 
-    When there is a duplicate key that is a hash, they are recursively merged.
-    When there is a duplicate key that is not a hash, the key in the rightmost hash will "win."
+      The resulting hash is equivalent to:
 
+      $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } }
+
+      When there is a duplicate key that is a hash, they are recursively merged.
+      When there is a duplicate key that is not a hash, the key in the rightmost hash will "win."
+
+    @return [Hash] The merged hash
     DOC
 
     if args.length < 2