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 collapse

Class Method Details

.configurationRaddocs::Configuration

Returns the current configuration

Returns:


14
15
16
# 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:


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

def self.configure
  yield configuration if block_given?
end