Module: Autodoc

Defined in:

lib/autodoc/configuration.rb,
lib/autodoc.rb,
lib/autodoc/version.rb,
lib/autodoc/document.rb,
lib/autodoc/collector.rb

Overview

You can configure documented headers.

Examples

# response.headers["X-Content-Type-Options"] will be documented.
Autodoc.configuration.headers << "X-Content-Type-Options"

Defined Under Namespace

Classes: Collector, Configuration, Document

Constant Summary

VERSION =

"0.1.3"

Class Method Summary

• .collector ⇒ Object
• .configuration ⇒ Object

Class Method Details

.collector ⇒ Object

# File 'lib/autodoc.rb', line 8

def collector
  @collector ||= Autodoc::Collector.new
end

.configuration ⇒ Object

# File 'lib/autodoc.rb', line 12

def configuration
  @configuration ||= Autodoc::Configuration.new
end