Class: Danger::UndocumentedReader

Inherits:
Object
  • Object
show all
Defined in:
lib/jazzy/undocumented_reader.rb

Overview

Reads undocumented.json file created by jazzy

Instance Method Summary collapse

Constructor Details

#initialize(path) ⇒ UndocumentedReader

Returns a new instance of UndocumentedReader.



4
5
6
 
# File 'lib/jazzy/undocumented_reader.rb', line 4

def initialize(path)
  load(path)
end

Instance Method Details

#undocumented_symbols ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/jazzy/undocumented_reader.rb', line 8

def undocumented_symbols
  @data['warnings'].map do |item|
    next unless item_valid? item
    Symbol.new(
      item_file(item),
      item['line'],
      item['symbol'],
      item['symbol_kind'],
      item['warning']
    )
  end
end