Contents

$:.unshift(File.dirname(__FILE__))

module Fdoc
  DEFAULT_SERVICE_PATH = "docs/fdoc"

  def self.scaffold_mode?
    ENV['FDOC_SCAFFOLD']
  end

  def self.service_path=(service_path)
    @service_path = service_path
  end

  def self.service_path
    @service_path || DEFAULT_SERVICE_PATH
  end

  def self.decide_success_with(&block)
    @success_block = block
  end

  def self.decide_success(*args)
    if @success_block
      @success_block.call(*args)
    else
      true
    end
  end

  # Top-level fdoc validation error, abstract.
  class ValidationError < StandardError; end

  # Indicates an unknown response code.
  class UndocumentedResponseCode < ValidationError; end
end

require 'fdoc/service'
require 'fdoc/meta_service'
require 'fdoc/endpoint'
require 'fdoc/endpoint_scaffold'
require 'fdoc/presenters/html_presenter'
require 'fdoc/presenters/service_presenter'
require 'fdoc/presenters/meta_service_presenter'
require 'fdoc/presenters/endpoint_presenter'
require 'fdoc/presenters/schema_presenter'
require 'fdoc/presenters/response_code_presenter'

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
fdoc-0.3.0	lib/fdoc.rb
fdoc-0.2.7	lib/fdoc.rb
fdoc-0.2.6	lib/fdoc.rb
fdoc-0.2.5	lib/fdoc.rb
fdoc-0.2.4	lib/fdoc.rb
fdoc-0.2.3	lib/fdoc.rb
fdoc-0.2.2	lib/fdoc.rb
fdoc-0.2.1	lib/fdoc.rb