Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / defined_with_params.rb
index fb0cd8c..cc2b90a 100644 (file)
@@ -3,19 +3,25 @@ require 'puppet/parser/functions'
 
 Puppet::Parser::Functions.newfunction(:defined_with_params,
                                       :type => :rvalue,
-                                      :doc => <<-'DOC'
-    Takes a resource reference and an optional hash of attributes.
+                                      :doc => <<-DOC
+    @summary
+      Takes a resource reference and an optional hash of attributes.
 
-    Returns true if a resource with the specified attributes has already been added
-    to the catalog, and false otherwise.
+    Returns `true` if a resource with the specified attributes has already been added
+    to the catalog, and `false` otherwise.
 
-        user { 'dan':
-          ensure => present,
-        }
+      ```
+      user { 'dan':
+        ensure => present,
+      }
 
-        if ! defined_with_params(User[dan], {'ensure' => 'present' }) {
-          user { 'dan': ensure => present, }
-        }
+      if ! defined_with_params(User[dan], {'ensure' => 'present' }) {
+        user { 'dan': ensure => present, }
+      }
+      ```
+
+    @return [Boolean]
+      returns `true` or `false`
 DOC
                                      ) do |vals|
   reference, params = vals