X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fensure_resource.rb;h=e4fa771f2d5d56f7e9a06ed29ec5c776c85cd617;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=1ba6a44782dafb34a7829db5372f0ee70ea330ad;hpb=ad88f67c13ae0f1a08936dad643f1e3509ab5f40;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/ensure_resource.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/ensure_resource.rb
index 1ba6a4478..e4fa771f2 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/ensure_resource.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/ensure_resource.rb
@@ -3,29 +3,35 @@ require 'puppet/parser/functions'
 
 Puppet::Parser::Functions.newfunction(:ensure_resource,
                                       :type => :statement,
-                                      :doc => <<-'ENDOFDOC'
-Takes a resource type, title, and a list of attributes that describe a
-resource.
+                                      :doc => <<-DOC
+  @summary
+    Takes a resource type, title, and a list of attributes that describe a
+    resource.
 
-    user { 'dan':
-      ensure => present,
-    }
+  user { 'dan':
+    ensure => present,
+  }
 
-This example only creates the resource if it does not already exist:
+  @return
+    created or recreated the passed resource with the passed type and attributes
 
-    ensure_resource('user', 'dan', {'ensure' => 'present' })
+  @example Example usage
 
-If the resource already exists but does not match the specified parameters,
-this function will attempt to recreate the resource leading to a duplicate
-resource definition error.
+    Creates the resource if it does not already exist:
 
-An array of resources can also be passed in and each will be created with
-the type and parameters specified if it doesn't already exist.
+      ensure_resource('user', 'dan', {'ensure' => 'present' })
 
-    ensure_resource('user', ['dan','alex'], {'ensure' => 'present'})
+    If the resource already exists but does not match the specified parameters,
+    this function will attempt to recreate the resource leading to a duplicate
+    resource definition error.
 
-ENDOFDOC
-) do |vals|
+    An array of resources can also be passed in and each will be created with
+    the type and parameters specified if it doesn't already exist.
+
+      ensure_resource('user', ['dan','alex'], {'ensure' => 'present'})
+
+DOC
+                                     ) do |vals|
   type, title, params = vals
   raise(ArgumentError, 'Must specify a type') unless type
   raise(ArgumentError, 'Must specify a title') unless title