Class: Dox::Formatter::CurrentExample

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/dox/formatter.rb

Overview

:nodoc:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(example) ⇒ CurrentExample

Returns a new instance of CurrentExample.



81
82
83
 
# File 'lib/dox/formatter.rb', line 81

def initialize(example)
  @example = example
end

Instance Attribute Details

#example ⇒ Object (readonly)

Returns the value of attribute example.



79
80
81
 
# File 'lib/dox/formatter.rb', line 79

def example
  @example
end

Instance Method Details

#action_name ⇒ Object 



97
98
99
 
# File 'lib/dox/formatter.rb', line 97

def action_name
  metadata[:action_name]
end

#document? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/dox/formatter.rb', line 109

def document?
  tagged_with?(:apidoc) && tagged_with?(:dox) && !tagged_with?(:nodoc)
end

#request ⇒ Object 



101
102
103
 
# File 'lib/dox/formatter.rb', line 101

def request
  metadata[:request]
end

#resource_group_desc ⇒ Object 



89
90
91
 
# File 'lib/dox/formatter.rb', line 89

def resource_group_desc
  metadata[:resource_group_desc]
end

#resource_group_name ⇒ Object 



85
86
87
 
# File 'lib/dox/formatter.rb', line 85

def resource_group_name
  metadata[:resource_group_name]
end

#resource_name ⇒ Object 



93
94
95
 
# File 'lib/dox/formatter.rb', line 93

def resource_name
  metadata[:resource_name]
end

#response ⇒ Object 



105
106
107
 
# File 'lib/dox/formatter.rb', line 105

def response
  metadata[:response]
end