Module: Raddocs

Defined in:

lib/raddocs.rb,
lib/raddocs/app.rb,
lib/raddocs/models.rb,
lib/raddocs/middleware.rb,
lib/raddocs/configuration.rb

Defined Under Namespace

Classes: App, Configuration, Example, Index, IndexExample, Middleware, Parameter, Parameters, Request, Resource, ResponseField, ResponseFields

Class Method Summary

• .configuration ⇒ Raddocs::Configuration

  The current configuration.

• .configure {|configuration| ... } ⇒ Object

  Configure Raddocs.

Class Method Details

.configuration ⇒ Raddocs::Configuration

Returns the current configuration.

Returns:

• (Raddocs::Configuration) —

  the current configuration

# File 'lib/raddocs.rb', line 14

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Configure Raddocs

Examples:

Raddocs.configure do |config|
  config.url_prefix = "/documentation"
end

Yield Parameters:

• configuration (Raddocs::Configuration)

# File 'lib/raddocs.rb', line 26

def self.configure
  yield configuration if block_given?
end