Class: YARD::Handlers::Ruby::Mongoid::Relations::Base

Inherits:
YARD::Handlers::Ruby::MethodHandler
  • Object
show all
Includes:
Helpers
Defined in:
lib/yard/handlers/ruby/mongoid/relations/base.rb

Direct Known Subclasses

PluralHandler, SingularHandler

Instance Method Summary collapse

Methods included from Helpers

#get_tag

Instance Method Details

#group_name ⇒ Object 



23
24
25
 
# File 'lib/yard/handlers/ruby/mongoid/relations/base.rb', line 23

def group_name
  'Mongoid Relations'
end

#process ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/yard/handlers/ruby/mongoid/relations/base.rb', line 11

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

  object           = YARD::CodeObjects::MethodObject.new(namespace, method_name)
  object.group     = group_name
  object.docstring = return_description
  object.docstring.add_tag get_tag(:return, '', class_name)
  object.docstring.add_tag get_tag(:see, "http://mongoid.org/en/mongoid/docs/relations.html##{statement.method_name(true).to_s}")
  object.dynamic = true
  register object
end