Sha256: 61a068bae75f0a45658d58e7675e3a63b062dd1f604001947ca6fddeaf6bf91f
Contents?: true
Size: 796 Bytes
Versions: 13
Compression:
Stored size: 796 Bytes
Contents
require 'puppet-strings/yard/code_objects'
# Implements a parameter directive (e.g. #@!puppet.type.param) for documenting Puppet resource types.
class PuppetStrings::Yard::Tags::ParameterDirective < YARD::Tags::Directive
# Called to invoke the directive.
# @return [void]
def call
return unless object && object.respond_to?(:add_parameter)
# Add a parameter to the resource
parameter = PuppetStrings::Yard::CodeObjects::Type::Parameter.new(tag.name, tag.text)
if tag.types
tag.types.each do |value|
parameter.add(value)
end
end
object.add_parameter parameter
end
# Registers the directive with YARD.
# @return [void]
def self.register!
YARD::Tags::Library.define_directive('puppet.type.param', :with_types_and_name, self)
end
end
Version data entries
13 entries across 13 versions & 1 rubygems