module YARD::Handlers::Ruby::DSLHandlerMethods
Constants
- IGNORE_METHODS
Public Instance Methods
handle_comments()
click to toggle source
# File lib/yard/handlers/ruby/dsl_handler_methods.rb, line 14 def handle_comments return if IGNORE_METHODS[caller_method] @docstring = statement.comments || "" @docstring = @docstring.join("\n") if @docstring.is_a?(Array) attaching = false if @docstring =~ /^@!?macro\s+\[[^\]]*attach/ register_docstring(nil) @docstring = "" attaching = true end macro = find_attached_macro if macro txt = macro.expand([caller_method, *call_params], statement.source) @docstring += "\n" + txt # macro may have a directive return register_docstring(nil) if !attaching && txt.match(/^\s*@!/) elsif !statement.comments_hash_flag && !implicit_docstring? return register_docstring(nil) end # ignore DSL definitions if @method/@attribute directive is used if @docstring =~ /^@!?(method|attribute)\b/ return register_docstring(nil) end register MethodObject.new(namespace, method_name, scope) do |o| o.signature = method_signature end end
register_docstring(object, docstring = @docstring, stmt = statement)
click to toggle source
Calls superclass method
# File lib/yard/handlers/ruby/dsl_handler_methods.rb, line 48 def register_docstring(object, docstring = @docstring, stmt = statement) super end
Private Instance Methods
find_attached_macro()
click to toggle source
# File lib/yard/handlers/ruby/dsl_handler_methods.rb, line 72 def find_attached_macro Registry.all(:macro).each do |macro| next unless macro.method_object next unless macro_name_matches(macro) (namespace.inheritance_tree(true) + [P('Object')]).each do |obj| return macro if obj == macro.method_object.namespace end end nil end
implicit_docstring?()
click to toggle source
# File lib/yard/handlers/ruby/dsl_handler_methods.rb, line 54 def implicit_docstring? tags = %w(method attribute overload visibility scope return) tags.any? {|tag| @docstring =~ /^@!?#{tag}\b/ } end
macro_name_matches(macro)
click to toggle source
@return [Boolean] whether caller method matches a macro or
its alias names.
# File lib/yard/handlers/ruby/dsl_handler_methods.rb, line 85 def macro_name_matches(macro) objs = [macro.method_object] if objs.first.type != :proxy && objs.first.respond_to?(:aliases) objs.concat(objs.first.aliases) end objs.any? {|obj| obj.name.to_s == caller_method.to_s } end
method_name()
click to toggle source
# File lib/yard/handlers/ruby/dsl_handler_methods.rb, line 59 def method_name name = call_params.first || "" if name =~ /^#{CodeObjects::METHODNAMEMATCH}$/ name else raise UndocumentableError, "method, missing name" end end
method_signature()
click to toggle source
# File lib/yard/handlers/ruby/dsl_handler_methods.rb, line 68 def method_signature "def #{method_name}" end