Class: Inch::Language::Nodejs::Provider::JSDoc::Parser
- Inherits:
-
Object
- Object
- Inch::Language::Nodejs::Provider::JSDoc::Parser
- Defined in:
- lib/inch/language/nodejs/provider/jsdoc/parser.rb
Overview
Parses the source tree (using JSDoc)
Constant Summary collapse
- IGNORE_TYPES =
%w(member package)
Instance Attribute Summary collapse
-
#parsed_objects ⇒ Object
readonly
Returns the value of attribute parsed_objects.
Class Method Summary collapse
-
.parse(*args) ⇒ CodeObject::Provider::JSDoc::Parser
Helper method to parse an instance with the given
args
.
Instance Method Summary collapse
Instance Attribute Details
#parsed_objects ⇒ Object (readonly)
Returns the value of attribute parsed_objects.
13 14 15 |
# File 'lib/inch/language/nodejs/provider/jsdoc/parser.rb', line 13 def parsed_objects @parsed_objects end |
Class Method Details
.parse(*args) ⇒ CodeObject::Provider::JSDoc::Parser
Helper method to parse an instance with the given args
20 21 22 23 24 |
# File 'lib/inch/language/nodejs/provider/jsdoc/parser.rb', line 20 def self.parse(*args) parser = new parser.parse(*args) parser end |
Instance Method Details
#objects ⇒ Array<YARD::Object::Base>
37 38 39 40 41 |
# File 'lib/inch/language/nodejs/provider/jsdoc/parser.rb', line 37 def objects @objects ||= parsed_objects.map do |o| JSDoc::Object.for(o) unless IGNORE_TYPES.include?(o['kind']) end.compact end |
#parse(dir, config) ⇒ void
This method returns an undefined value.
29 30 31 32 33 34 |
# File 'lib/inch/language/nodejs/provider/jsdoc/parser.rb', line 29 def parse(dir, config) Dir.chdir(dir) do parse_objects(config.included_files, config.excluded_files, config.read_dump_file) end end |