Class: Falkor::Yard::Documentation

Inherits:
Object
  • Object
show all
Includes:
TrackableProgress
Defined in:
lib/falkor/yard/documentation.rb

Constant Summary collapse

FILE_GLOB = 
YARD::Parser::SourceParser::DEFAULT_PATH_GLOB + ["*.c", "ext/**/*.rb"]

Instance Method Summary collapse

Methods included from TrackableProgress

#report_progress

Constructor Details

#initialize(source_dir, yardoc_file = ".yardoc") ⇒ Documentation

Returns a new instance of Documentation.



15
16
17
18
 
# File 'lib/falkor/yard/documentation.rb', line 15

def initialize(source_dir, yardoc_file = ".yardoc")
  @source_dir = source_dir
  @yardoc_file = yardoc_file
end

Instance Method Details

#generate ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/falkor/yard/documentation.rb', line 20

def generate
  in_source_dir do
    with_yardoc_file do
      YARD::Registry.lock_for_writing do
        report_progress(:parse_files, files.size, &Proc.new)
        YARD::Registry.save(true)
      end
    end
  end

  yardoc_file
end