Module: Betterdocs::Representer::ClassMethods

Defined in:
lib/betterdocs/representer.rb

Instance Method Summary collapse

Instance Method Details

#apply(object) ⇒ Object 



17
18
19
 
# File 'lib/betterdocs/representer.rb', line 17

def apply(object)
  object.extend self
end

#build_result_object ⇒ Object 



21
22
23
 
# File 'lib/betterdocs/representer.rb', line 21

def build_result_object
  {}
end

#doc(type, name, **options, &block) ⇒ Object 



32
33
34
 
# File 'lib/betterdocs/representer.rb', line 32

def doc(type, name, **options, &block)
  docs.add_element(self, type, name, **options, &block)
end

#docs ⇒ Object

Raises:

  • (NotImplementedError) 


38
39
40
 
# File 'lib/betterdocs/representer.rb', line 38

def docs
  raise NotImplementedError, 'has to be implemented in including module'
end

#hashify(object, &block) ⇒ Object 



25
26
27
28
29
30
 
# File 'lib/betterdocs/representer.rb', line 25

def hashify(object, &block)
  apply(object)
  result = build_result_object
  instance_exec(result, &block)
  result
end

#object_name ⇒ Object 



36
 
# File 'lib/betterdocs/representer.rb', line 36

def object_name(*) end