Class: Yoda::Model::Descriptions::FunctionDescription
- Defined in:
- lib/yoda/model/descriptions/function_description.rb
Instance Attribute Summary collapse
-
#function ⇒ Object
readonly
Returns the value of attribute function.
Instance Method Summary collapse
-
#initialize(function) ⇒ FunctionDescription
constructor
A new instance of FunctionDescription.
- #parameter_names ⇒ Object
- #signature ⇒ Object
- #sort_text ⇒ Object
- #title ⇒ Object
- #to_markdown ⇒ Object
Constructor Details
#initialize(function) ⇒ FunctionDescription
Returns a new instance of FunctionDescription.
9 10 11 12 |
# File 'lib/yoda/model/descriptions/function_description.rb', line 9 def initialize(function) fail ArgumentError, function unless function.is_a?(FunctionSignatures::Base) @function = function end |
Instance Attribute Details
#function ⇒ Object (readonly)
Returns the value of attribute function.
6 7 8 |
# File 'lib/yoda/model/descriptions/function_description.rb', line 6 def function @function end |
Instance Method Details
#parameter_names ⇒ Object
26 27 28 |
# File 'lib/yoda/model/descriptions/function_description.rb', line 26 def parameter_names function.parameters.parameter_names end |
#signature ⇒ Object
18 19 20 |
# File 'lib/yoda/model/descriptions/function_description.rb', line 18 def signature "#{function.to_s}" end |
#sort_text ⇒ Object
22 23 24 |
# File 'lib/yoda/model/descriptions/function_description.rb', line 22 def sort_text function.name.to_s end |
#title ⇒ Object
14 15 16 |
# File 'lib/yoda/model/descriptions/function_description.rb', line 14 def title "#{function.namespace_path}#{function.sep}#{function.to_s}" end |
#to_markdown ⇒ Object
30 31 32 33 34 35 36 |
# File 'lib/yoda/model/descriptions/function_description.rb', line 30 def to_markdown <<~EOS **#{title}** #{function.document} EOS end |