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

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

Overview

Implements the handler for JSON task metadata.

Instance Method Summary collapse

Methods inherited from Base

handles?

Instance Method Details

#validate_description ⇒ Object 



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

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

#validate_params ⇒ Object 



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

def validate_params
  return if @statement.parameters.empty?

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