class PuppetStrings::Yard::Tags::ParameterDirective
Implements a parameter directive (e.g. #@!puppet.type.param) for documenting Puppet
resource types.
Public Class Methods
Source
# File lib/puppet-strings/yard/tags/parameter_directive.rb, line 22 def self.register! YARD::Tags::Library.define_directive('puppet.type.param', :with_types_and_name, self) end
Registers the directive with YARD
. @return [void]
Public Instance Methods
Source
# File lib/puppet-strings/yard/tags/parameter_directive.rb, line 9 def call return unless object.respond_to?(:add_parameter) # Add a parameter to the resource parameter = PuppetStrings::Yard::CodeObjects::Type::Parameter.new(tag.name, tag.text) tag.types&.each do |value| parameter.add(value) end object.add_parameter parameter end
Called to invoke the directive. @return [void]