Class: YARD::Handlers::Ruby::ActiveRecord::Associations::Base

Inherits:
MethodHandler
  • Object
show all
Defined in:
lib/yard-activerecord/associations/base.rb

Direct Known Subclasses

PluralHandler, SingularHandler

Instance Method Summary collapse

Instance Method Details

#group_name ⇒ Object 



19
20
21
 
# File 'lib/yard-activerecord/associations/base.rb', line 19

def group_name
  "Active Record Associations"
end

#process ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/yard-activerecord/associations/base.rb', line 7

def process
  namespace.groups << group_name unless namespace.groups.include? group_name

  object           = register YARD::CodeObjects::MethodObject.new(namespace, method_name)
  object.group     = group_name
  object.docstring = return_description if object.docstring.empty?
  object.docstring.add_tag get_tag(:return, '', class_name)
  object.docstring.add_tag get_tag(:see, "ActiveRecord::Associations", nil,
    'http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html' )
  object.dynamic = true
end