Module: Smooth::Documentation

Included in:
Api, Api::Policy, Query, Resource, Serializer
Defined in:
lib/smooth/documentation.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
 
# File 'lib/smooth/documentation.rb', line 3

def self.included(base)
  base.class_eval do
    attr_accessor :_inline_description

    class << self
      attr_accessor :_inline_description
    end
  end

  base.extend Smooth::Documentation
end

Instance Method Details

#desc(description, *args) ⇒ Object 



15
16
17
18
19
20
 
# File 'lib/smooth/documentation.rb', line 15

def desc(description, *args)
  self._inline_description = {
    description: description,
    args: args
  }
end

#inline_description ⇒ Object 



22
23
24
25
26
 
# File 'lib/smooth/documentation.rb', line 22

def inline_description
  val = _inline_description && _inline_description.dup
  self._inline_description = nil
  val
end