Class: ApiDocs::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/api_docs/configuration.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Configuration defaults



17
18
19
20
21
22
 
# File 'lib/api_docs/configuration.rb', line 17

def initialize
  @docs_path          = Rails.root.join('doc/api')
  @base_controller    = 'ApplicationController'
  @ignored_attributes = %w(created_at updated_at)
  @reload_docs_folder = false
end

Instance Attribute Details

#base_controller ⇒ Object

Controller that ApiDocs::DocsController inherits from



7
8
9
 
# File 'lib/api_docs/configuration.rb', line 7

def base_controller
  @base_controller
end

#docs_path ⇒ Object

Where to find the folder with documentation files



4
5
6
 
# File 'lib/api_docs/configuration.rb', line 4

def docs_path
  @docs_path
end

#ignored_attributes ⇒ Object

Array of ignored attributes. Attributes that don’t really change the content like timestamps.



11
12
13
 
# File 'lib/api_docs/configuration.rb', line 11

def ignored_attributes
  @ignored_attributes
end

#reload_docs_folder ⇒ Object

Remove doc files before running tests. False by default.



14
15
16
 
# File 'lib/api_docs/configuration.rb', line 14

def reload_docs_folder
  @reload_docs_folder
end