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.



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

def initialize(example)
  @example = example
end

Instance Attribute Details

#example ⇒ Object (readonly)

Returns the value of attribute example.



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

def example
  @example
end

Instance Method Details

#action_name ⇒ Object 



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

def action_name
  metadata[:action_name]
end

#document? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#request ⇒ Object 



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

def request
  metadata[:request]
end

#resource_group_desc ⇒ Object 



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

def resource_group_desc
  metadata[:resource_group_desc]
end

#resource_group_name ⇒ Object 



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

def resource_group_name
  metadata[:resource_group_name]
end

#resource_name ⇒ Object 



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

def resource_name
  metadata[:resource_name]
end

#response ⇒ Object 



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

def response
  metadata[:response]
end