Class: PuppetStrings::Markdown::Function::Signature

Inherits:
Base
  • Object
show all
Defined in:
lib/puppet-strings/markdown/function.rb

Overview

Implements methods to retrieve information about a function signature.

Instance Method Summary collapse

Methods inherited from Base

#defaults, #enums, #enums_for_param, #examples, group_name, items, #link, #name, #options, #options_for_param, #params, #private?, #raises, #render, #return_type, #see, #since, #text, #toc_info, #word_wrap, yard_types

Methods included from Helpers

#code_maybe_block

Constructor Details

#initialize(registry) ⇒ Signature

Returns a new instance of Signature.



50
51
52
53
# File 'lib/puppet-strings/markdown/function.rb', line 50

def initialize(registry)
  @registry = registry
  super(@registry, 'function signature')
end

Instance Method Details

#signatureObject



55
56
57
# File 'lib/puppet-strings/markdown/function.rb', line 55

def signature
  @registry[:signature]
end