Sha256: bdfb676ef719658bdacb01d192abbb7ac1c2f2de3c34781a796ef7db2518cba2
Contents?: true
Size: 1.18 KB
Versions: 6
Compression:
Stored size: 1.18 KB
Contents
# frozen_string_literal: true
require 'puppet-strings/markdown/base'
module PuppetStrings::Markdown
# Generates Markdown for a Puppet Function.
class Function < Base
attr_reader :signatures
group_name 'Functions'
yard_types [:puppet_function]
def initialize(registry)
@template = 'function.erb'
super(registry, 'function')
@signatures = []
registry[:signatures].each do |sig|
@signatures.push(Signature.new(sig))
end
end
def render
super(@template)
end
def type
t = @registry[:type]
if t.include?('ruby4x')
'Ruby 4.x API'
elsif t.include?('ruby3')
'Ruby 3.x API'
elsif t.include?('ruby')
'Ruby'
else
'Puppet Language'
end
end
def error_type(type)
"`#{type.split[0]}`"
end
def error_text(text)
text.split.drop(1).join(' ').to_s
end
end
# Implements methods to retrieve information about a function signature.
class Function::Signature < Base
def initialize(registry)
@registry = registry
super(@registry, 'function signature')
end
def signature
@registry[:signature]
end
end
end
Version data entries
6 entries across 6 versions & 1 rubygems