Class: Raddocs::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/raddocs/configuration.rb

Overview

Configure Raddocs

Examples:

Raddocs.configure do |config|
  # config is this class
  config.api_name = "My API"
end

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#api_name ⇒ String

Returns defaults to “Api Documentation”.

Returns:

  • (String) —

    defaults to “Api Documentation”



38
 
# File 'lib/raddocs/configuration.rb', line 38

add_setting :api_name, :default => "Api Documentation"

#docs_dir ⇒ String

Returns defaults to ‘doc/api’.

Returns:

  • (String) —

    defaults to ‘doc/api’



30
 
# File 'lib/raddocs/configuration.rb', line 30

add_setting :docs_dir, :default => "doc/api"

#docs_mime_type ⇒ Regexp

Returns defaults to Regexp.new(“text/docs+plain”).

Returns:

  • (Regexp) —

    defaults to Regexp.new(“text/docs+plain”)



34
 
# File 'lib/raddocs/configuration.rb', line 34

add_setting :docs_mime_type, :default => /text\/docs\+plain/

#external_css ⇒ Array

Returns array of Strings, defaults to [].

Returns:

  • (Array) —

    array of Strings, defaults to []



46
 
# File 'lib/raddocs/configuration.rb', line 46

add_setting :external_css, :default => []

#include_bootstrap ⇒ Boolean

Returns defaults to true.

Returns:

  • (Boolean) —

    defaults to true



42
 
# File 'lib/raddocs/configuration.rb', line 42

add_setting :include_bootstrap, :default => true

#url_prefix ⇒ String

Returns defaults to nil.

Returns:

  • (String) —

    defaults to nil



50
 
# File 'lib/raddocs/configuration.rb', line 50

add_setting :url_prefix, :default => nil

Class Method Details

.add_setting(name, opts = {}) ⇒ Object

Configures a new setting, creates two methods

Parameters:

  • name (Symbol) —

    name of the setting

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • default (Object) —

    default value of setting



15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/raddocs/configuration.rb', line 15

def self.add_setting(name, opts = {})
  define_method("#{name}=") { |value| settings[name] = value }
  define_method("#{name}") do
    if settings.has_key?(name)
      settings[name]
    elsif opts[:default].respond_to?(:call)
      opts[:default].call(self)
    else
      opts[:default]
    end
  end
end