summaryrefslogtreecommitdiff
path: root/lib/chef/resource/chef_handler.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2019-03-11 16:27:27 -0700
committerTim Smith <tsmith@chef.io>2019-03-11 16:54:50 -0700
commitaf4ba14f511780ce55737aec2d346d0bf1afb962 (patch)
treeac5af9e99a1f87ff1d8d12551c300982ccd8fb0d /lib/chef/resource/chef_handler.rb
parent62c6ff31ea837b2b4c361e413191090fc9e4b4a7 (diff)
downloadchef-af4ba14f511780ce55737aec2d346d0bf1afb962.tar.gz
Add misc YARD commentsyard3
A pile of misc yard I added as I was reading things. Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/chef_handler.rb')
-rw-r--r--lib/chef/resource/chef_handler.rb3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/chef/resource/chef_handler.rb b/lib/chef/resource/chef_handler.rb
index 6d55f882bd..2bac109697 100644
--- a/lib/chef/resource/chef_handler.rb
+++ b/lib/chef/resource/chef_handler.rb
@@ -92,6 +92,8 @@ class Chef
#
# @param handler_type [Symbol] such as :report or :exception.
# @param class_full_name [String] such as 'Chef::Handler::ErrorReport'.
+ #
+ # @return [void]
def unregister_handler(handler_type, class_full_name)
Chef::Config.send("#{handler_type}_handlers").delete_if do |v|
# avoid a bit of log spam
@@ -106,6 +108,7 @@ class Chef
# If the class is not available, NameError is thrown.
#
# @param class_full_name [String] full class name such as 'Chef::Handler::Foo' or 'MyHandler'.
+ #
# @return [Array] parent class and child class.
def get_class(class_full_name)
ancestors = class_full_name.split("::")