Method: JsDuck::ClassFormatter#format

Defined in:
lib/jsduck/class_formatter.rb

#format(cls) ⇒ Object

Runs the formatter on doc object of a class. Accessed using Class#internal_doc



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/jsduck/class_formatter.rb', line 25

def format(cls)
  @cls = cls
  @formatter.class_context = cls[:name]
  @formatter.doc_context = cls[:files][0]
  cls[:doc] = @formatter.format(cls[:doc]) if cls[:doc]
  # format all members (except hidden ones)
  cls[:members] = cls[:members].map {|m| m[:meta][:hide] ? m : format_member(m)  }
  cls[:html_meta] = format_meta_data(cls)
  cls
end