Module: Documented

Defined in:
lib/config.rb,
lib/tracer.rb,
lib/renderer.rb,
lib/rewriter.rb,
lib/documented.rb

Defined Under Namespace

Classes: Config, Renderer, Rewriter, Tracer

Class Method Summary collapse

Class Method Details

.add_sequence(sequence) ⇒ Object 



32
33
34
 
# File 'lib/documented.rb', line 32

def add_sequence(sequence)
  @@sequences << sequence
end

.config ⇒ Object 



36
37
38
 
# File 'lib/documented.rb', line 36

def config
  @@config
end

.configure {|@@config| ... } ⇒ Object

Allow end-user to override config.

Yields:



45
46
47
 
# File 'lib/documented.rb', line 45

def configure
  yield(@@config)
end

.disable ⇒ Object 



23
24
25
26
 
# File 'lib/documented.rb', line 23

def disable
  @@tracer.disable
  @@renderer.render(@@file_path)
end

.enable ⇒ Object 



19
20
21
 
# File 'lib/documented.rb', line 19

def enable
  @@tracer.enable 
end

.sequences ⇒ Object 



28
29
30
 
# File 'lib/documented.rb', line 28

def sequences
  @@sequences
end

.setup(file_path) ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/documented.rb', line 7

def setup(file_path)
  @@file_path = file_path
  @@config = Config.new
  @@tracer = Tracer.new(@@config.blocklist)

  output_path = File.join(@@config.app_path, @@config.output_directory)
  Dir.mkdir(output_path) unless Dir.exist? output_path
  @@renderer = Renderer.new(@@config.gem_path, output_path)

  @@sequences = []
end

.tracer ⇒ Object 



40
41
42
 
# File 'lib/documented.rb', line 40

def tracer
  @@tracer
end