Module: Dox

Defined in:
lib/dox.rb,
lib/dox/config.rb,
lib/dox/version.rb,
lib/dox/formatter.rb,
lib/dox/util/file.rb,
lib/dox/util/http.rb,
lib/dox/dsl/action.rb,
lib/dox/dsl/syntax.rb,
lib/dox/dsl/resource.rb,
lib/dox/html_renderer.rb,
lib/dox/dsl/attr_proxy.rb,
lib/dox/formatters/xml.rb,
lib/dox/entities/action.rb,
lib/dox/formatters/base.rb,
lib/dox/formatters/json.rb,
lib/dox/redocly_adapter.rb,
lib/dox/entities/example.rb,
lib/dox/formatters/plain.rb,
lib/dox/dsl/documentation.rb,
lib/dox/entities/resource.rb,
lib/dox/dsl/resource_group.rb,
lib/dox/formatters/multipart.rb,
lib/dox/printers/base_printer.rb,
lib/dox/entities/resource_group.rb,
lib/dox/printers/action_printer.rb,
lib/dox/printers/document_printer.rb,
lib/dox/printers/resource_printer.rb,
lib/dox/errors/file_not_found_error.rb,
lib/dox/errors/invalid_action_error.rb,
lib/dox/errors/folder_not_found_error.rb,
lib/dox/errors/invalid_resource_error.rb,
lib/dox/printers/resource_group_printer.rb,
lib/dox/printers/example_request_printer.rb,
lib/dox/printers/example_response_printer.rb,
lib/dox/errors/invalid_resource_group_error.rb

Defined Under Namespace

Modules: DSL, Entities, Errors, Formatters, Printers, Util Classes: Config, Error, Formatter, HtmlRenderer, RedoclyAdapter

Constant Summary collapse

DEFAULT_HEADERS_WHITELIST = 
['Accept', 'Content-Type'].freeze
VERSION = 
'3.0.1'.freeze

Class Method Summary collapse

Class Method Details

.config ⇒ Object 



51
52
53
 
# File 'lib/dox.rb', line 51

def self.config
  @config ||= Dox::Config.new
end

.configure {|config| ... } ⇒ Object

Yields:



47
48
49
 
# File 'lib/dox.rb', line 47

def self.configure
  yield(config) if block_given?
end

.full_headers_whitelist ⇒ Object 



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

def self.full_headers_whitelist
  (config.headers_whitelist.to_a + DEFAULT_HEADERS_WHITELIST).uniq
end