Class: Dox::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/dox/config.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#api_version ⇒ Object

Returns the value of attribute api_version.



8
9
10
 
# File 'lib/dox/config.rb', line 8

def api_version
  @api_version
end

#check_file_presence_on_init ⇒ Object 



41
42
43
44
45
 
# File 'lib/dox/config.rb', line 41

def check_file_presence_on_init
  return false if @check_file_presence_on_init == false

  @check_file_presence_on_init || true
end

#descriptions_location ⇒ Object

Returns the value of attribute descriptions_location.



12
13
14
 
# File 'lib/dox/config.rb', line 12

def descriptions_location
  @descriptions_location
end

#groups_order ⇒ Object

Returns the value of attribute groups_order.



11
12
13
 
# File 'lib/dox/config.rb', line 11

def groups_order
  @groups_order
end

#header_description ⇒ Object

Returns the value of attribute header_description.



10
11
12
 
# File 'lib/dox/config.rb', line 10

def header_description
  @header_description
end

#headers_whitelist ⇒ Object

Returns the value of attribute headers_whitelist.



6
7
8
 
# File 'lib/dox/config.rb', line 6

def headers_whitelist
  @headers_whitelist
end

#openapi_version ⇒ Object

Returns the value of attribute openapi_version.



7
8
9
 
# File 'lib/dox/config.rb', line 7

def openapi_version
  @openapi_version
end

#schema_request_folder_path ⇒ Object

Returns the value of attribute schema_request_folder_path.



3
4
5
 
# File 'lib/dox/config.rb', line 3

def schema_request_folder_path
  @schema_request_folder_path
end

#schema_response_fail_file_path ⇒ Object

Returns the value of attribute schema_response_fail_file_path.



5
6
7
 
# File 'lib/dox/config.rb', line 5

def schema_response_fail_file_path
  @schema_response_fail_file_path
end

#schema_response_folder_path ⇒ Object

Returns the value of attribute schema_response_folder_path.



4
5
6
 
# File 'lib/dox/config.rb', line 4

def schema_response_folder_path
  @schema_response_folder_path
end

#title ⇒ Object

Returns the value of attribute title.



9
10
11
 
# File 'lib/dox/config.rb', line 9

def title
  @title
end

Instance Method Details

#desc_folder_path=(folder_path) ⇒ Object 



47
48
49
50
51
52
53
 
# File 'lib/dox/config.rb', line 47

def desc_folder_path=(folder_path)
  warn(
    'DEPRECATION WARNING: desc_folder_path will be removed in the next release, please use descriptions_location instead' # rubocop:disable Layout/LineLength
  )

  self.descriptions_location = folder_path
end

#header_file_path=(_file_path) ⇒ Object 



55
56
57
 
# File 'lib/dox/config.rb', line 55

def header_file_path=(_file_path)
  warn('WARNING: header_file_path is no longer used. Move header description to config.header_description.')
end