Method: JsDuck::App#format_classes

Defined in:
lib/jsduck/app.rb

#format_classes ⇒ Object

Formats each class



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/jsduck/app.rb', line 153

def format_classes
  doc_formatter = DocFormatter.new(@relations, @opts)
  doc_formatter.img_path = "images"
  class_formatter = ClassFormatter.new(@relations, doc_formatter)
  # Don't format types when exporting
  class_formatter.include_types = !@opts.export
  # Format all doc-objects in parallel
  formatted_classes = @parallel.map(@relations.classes) do |cls|
    Logger.instance.log("Markdown formatting #{cls[:name]}")
    {
      :doc => class_formatter.format(cls.internal_doc),
      :images => doc_formatter.images
    }
  end
  # Then merge the data back to classes sequentially
  formatted_classes.each do |cls|
    @relations[cls[:doc][:name]].internal_doc = cls[:doc]
    cls[:images].each {|img| @assets.images.add(img) }
  end
end