Move code comments to where rdoc/yard expect them

4 files changed, 24 insertions, 22 deletions

diff --git a/lib/chef/deprecation/provider/cookbook_file.rb b/lib/chef/deprecation/provider/cookbook_file.rb
index 60fe200b89..dfbf4a39a4 100644
--- a/lib/chef/deprecation/provider/cookbook_file.rb
+++ b/lib/chef/deprecation/provider/cookbook_file.rb
@@ -16,15 +16,16 @@
 # limitations under the License.
 #
 
-#
-# This module contains the deprecated functions of
-# Chef::Provider::CookbookFile. These functions are refactored to different
-# components. They are frozen and will be removed in Chef 12.
-#
 
 class Chef
   module Deprecation
     module Provider
+
+      # == Deprecation::Provider::CookbookFile
+      # This module contains the deprecated functions of
+      # Chef::Provider::CookbookFile. These functions are refactored to
+      # different components. They are frozen and will be removed in Chef 12.
+      #
       module CookbookFile
 
         def file_cache_location
diff --git a/lib/chef/deprecation/provider/file.rb b/lib/chef/deprecation/provider/file.rb
index cc880641fb..0e9105247c 100644
--- a/lib/chef/deprecation/provider/file.rb
+++ b/lib/chef/deprecation/provider/file.rb
@@ -16,15 +16,16 @@
 # limitations under the License.
 #
 
-#
-# This module contains the deprecated functions of
-# Chef::Provider::File. These functions are refactored to different
-# components. They are frozen and will be removed in Chef 12.
-#
 
 class Chef
   module Deprecation
     module Provider
+
+      # == Deprecation::Provider::File
+      # This module contains the deprecated functions of
+      # Chef::Provider::File. These functions are refactored to different
+      # components. They are frozen and will be removed in Chef 12.
+      #
       module File
 
         def diff_current_from_content(new_content)
diff --git a/lib/chef/deprecation/provider/remote_file.rb b/lib/chef/deprecation/provider/remote_file.rb
index 2a528269d9..4452de67cd 100644
--- a/lib/chef/deprecation/provider/remote_file.rb
+++ b/lib/chef/deprecation/provider/remote_file.rb
@@ -16,15 +16,15 @@
 # limitations under the License.
 #
 
-#
-# This module contains the deprecated functions of
-# Chef::Provider::RemoteFile. These functions are refactored to different
-# components. They are frozen and will be removed in Chef 12.
-#
-
 class Chef
   module Deprecation
     module Provider
+
+      # == Deprecation::Provider::RemoteFile
+      # This module contains the deprecated functions of
+      # Chef::Provider::RemoteFile. These functions are refactored to different
+      # components. They are frozen and will be removed in Chef 12.
+      #
       module RemoteFile
 
         def current_resource_matches_target_checksum?
diff --git a/lib/chef/deprecation/provider/template.rb b/lib/chef/deprecation/provider/template.rb
index 7fe6d9ef7b..0f93c637f6 100644
--- a/lib/chef/deprecation/provider/template.rb
+++ b/lib/chef/deprecation/provider/template.rb
@@ -16,17 +16,17 @@
 # limitations under the License.
 #
 
-#
-# This module contains the deprecated functions of
-# Chef::Provider::Template. These functions are refactored to different
-# components. They are frozen and will be removed in Chef 12.
-#
-
 require 'chef/mixin/template'
 
 class Chef
   module Deprecation
     module Provider
+
+      # == Deprecation::Provider::Template
+      # This module contains the deprecated functions of
+      # Chef::Provider::Template. These functions are refactored to different
+      # components. They are frozen and will be removed in Chef 12.
+      #
       module Template
 
         include Chef::Mixin::Template