Update comments in the docs generator

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

1 files changed, 2 insertions, 4 deletions

diff --git a/tasks/docs.rb b/tasks/docs.rb
index 78e9c13b2c..0094929ed4 100755
--- a/tasks/docs.rb
+++ b/tasks/docs.rb
@@ -97,8 +97,7 @@ namespace :docs_site do
     # and removing any nil values since those are less types in properties
     # and more side effects of legacy design
     # @return String
-    # TODO:
-    # - still does not include nil (?)
+    # @todo still does not include nil (?)
     def friendly_types_list(arr)
       fixed_arr = Array(arr).map do |x|
         case x
@@ -138,8 +137,7 @@ namespace :docs_site do
       actions
     end
 
-    # TODO:
-    # - what to do about "lazy default" for default?
+    # @todo what to do about "lazy default" for default?
     def properties_list(properties)
       properties.filter_map do |property|
         next if property["name"] == "sensitive" # we don't need to document sensitive twice