Class: PuppetStrings::Yard::Handlers::JSON::TaskHandler

Inherits:
Base
  • Object
show all
Defined in:
lib/puppet-strings/yard/handlers/json/task_handler.rb

Instance Method Summary collapse

Methods inherited from Base

handles?

Instance Method Details

#validate_descriptionObject



22
23
24
# File 'lib/puppet-strings/yard/handlers/json/task_handler.rb', line 22

def validate_description
  log.warn "Missing a description for #{@kind}." if @statement.docstring.empty?
end

#validate_paramsObject



26
27
28
29
30
31
32
# File 'lib/puppet-strings/yard/handlers/json/task_handler.rb', line 26

def validate_params
  unless @statement.parameters.empty?
    @statement.parameters.each do |param, val|
      log.warn "Missing description for param '#{param}' in #{@kind}" if val['description'].nil?
    end
  end
end