Module: Fdoc

Defined in:
lib/fdoc.rb,
lib/fdoc/cli.rb,
lib/fdoc/spec_watcher.rb

Defined Under Namespace

Modules: SpecWatcher Classes: BasePresenter, Cli, Endpoint, EndpointPresenter, EndpointScaffold, JsonPresenter, MetaService, MetaServicePresenter, NotADirectory, NotFound, ResponseCodePresenter, SchemaPresenter, Service, ServicePresenter, UndocumentedResponseCode, ValidationError

Constant Summary collapse

DEFAULT_SERVICE_PATH = 
"docs/fdoc"

Class Method Summary collapse

Class Method Details

.decide_success(*args) ⇒ Object 



22
23
24
25
26
27
28
 
# File 'lib/fdoc.rb', line 22

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

.decide_success_with(&block) ⇒ Object 



18
19
20
 
# File 'lib/fdoc.rb', line 18

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

.scaffold_mode? ⇒ Boolean

Returns:

  • (Boolean) 


6
7
8
 
# File 'lib/fdoc.rb', line 6

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

.service_path ⇒ Object 



14
15
16
 
# File 'lib/fdoc.rb', line 14

def self.service_path
  @service_path || DEFAULT_SERVICE_PATH
end

.service_path=(service_path) ⇒ Object 



10
11
12
 
# File 'lib/fdoc.rb', line 10

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