Class: JsDuck::ClassDocExpander

Inherits:
Object
  • Object
show all
Defined in:
lib/jsduck/class_doc_expander.rb

Overview

Expands class docset into one or more docsets.

The resulting list can contain the following:

  • the base class docset itself (always present)

  • configs detected from comment

  • constructor detected from comment

  • members detected from code

Instance Method Summary collapse

Instance Method Details

#expand(docset) ⇒ Object

Expands class-docset into multiple docsets.



17
18
19
20
21
 
# File 'lib/jsduck/class_doc_expander.rb', line 17

def expand(docset)
  @constructor_found = false

  expand_comment(docset) + expand_code(docset)
end