Add descriptions and @since comments to all resources

From the docs site

Signed-off-by: Tim Smith <tsmith@chef.io>

1 files changed, 9 insertions, 0 deletions

diff --git a/lib/chef/resource/cookbook_file.rb b/lib/chef/resource/cookbook_file.rb
index f58ad786fc..8c3de119e9 100644
--- a/lib/chef/resource/cookbook_file.rb
+++ b/lib/chef/resource/cookbook_file.rb
@@ -24,6 +24,15 @@ require "chef/mixin/securable"
 
 class Chef
   class Resource
+    # Use the cookbook_file resource to transfer files from a sub-directory of COOKBOOK_NAME/files/ to a specified path
+    # located on a host that is running the chef-client. The file is selected according to file specificity, which allows
+    # different source files to be used based on the hostname, host platform (operating system, distro, or as appropriate),
+    # or platform version. Files that are located in the COOKBOOK_NAME/files/default sub-directory may be used on any
+    # platform.
+    #
+    # During a chef-client run, the checksum for each local file is calculated and then compared against the checksum for
+    # the same file as it currently exists in the cookbook on the Chef server. A file is not transferred when the checksums
+    # match. Only files that require an update are transferred from the Chef server to a node.
     class CookbookFile < Chef::Resource::File
       include Chef::Mixin::Securable