summaryrefslogtreecommitdiff
path: root/lib/chef/resource/windows_path.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2017-12-19 11:22:19 -0800
committerTim Smith <tsmith@chef.io>2017-12-19 11:22:19 -0800
commit034f00f6c466c3924e5fdb069b484d1961283c76 (patch)
treee2f6d9b911c838df661d1bd9cd643858a19847b9 /lib/chef/resource/windows_path.rb
parentfc813e21f253d5278cb42710874a34cfebfcc8ca (diff)
downloadchef-034f00f6c466c3924e5fdb069b484d1961283c76.tar.gz
Add descriptions and @since comments to all resources
From the docs site Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/windows_path.rb')
-rw-r--r--lib/chef/resource/windows_path.rb3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/chef/resource/windows_path.rb b/lib/chef/resource/windows_path.rb
index 5472a7e4fd..9274415755 100644
--- a/lib/chef/resource/windows_path.rb
+++ b/lib/chef/resource/windows_path.rb
@@ -20,6 +20,9 @@ require "chef/resource"
class Chef
class Resource
+ # Use the windows_path resource to manage the path environment variable on Microsoft Windows.
+ #
+ # @since 13.4
class WindowsPath < Chef::Resource
provides :windows_path, os: "windows"