class Yoda::Model::Descriptions::FunctionDescription
Attributes
function[R]
Public Class Methods
new(function)
click to toggle source
@param function [FunctionSignatures::Base]
# 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
Public Instance Methods
parameter_names()
click to toggle source
# File lib/yoda/model/descriptions/function_description.rb, line 26 def parameter_names function.parameters.parameter_names end
signature()
click to toggle source
# File lib/yoda/model/descriptions/function_description.rb, line 18 def signature "#{function.to_s}" end
sort_text()
click to toggle source
# File lib/yoda/model/descriptions/function_description.rb, line 22 def sort_text function.name.to_s end
title()
click to toggle source
# File lib/yoda/model/descriptions/function_description.rb, line 14 def title "#{function.namespace_path}#{function.sep}#{function.to_s}" end
to_markdown()
click to toggle source
# File lib/yoda/model/descriptions/function_description.rb, line 30 def to_markdown <<~EOS **#{title}** #{function.document} EOS end