Contents

require "jsduck/tag/tag"
require 'jsduck/format/shortener'

module JsDuck::Tag
  # A special class for rendering the documentation field inside
  # classes and members.
  class Doc < Tag
    def initialize
      @tagname = :doc
      @html_position = POS_DOC
      @shortener = JsDuck::Format::Shortener.new
    end

    def format(m, formatter)
      m[:doc] = formatter.format(m[:doc])

      if expandable?(m) || @shortener.too_long?(m[:doc])
        m[:short_doc] = @shortener.shorten(m[:doc])
      end
    end

    def to_html(m)
      m[:doc]
    end

    private

    def expandable?(m)
      m[:params] || (m[:properties] && m[:properties].length > 0) || m[:default] || m[:deprecated] || m[:template]
    end
  end
end

Version data entries

30 entries across 30 versions & 3 rubygems

Version	Path
jsduck-5.3.0	lib/jsduck/tag/doc.rb
jsduck-5.2.0	lib/jsduck/tag/doc.rb
jsduck-5.1.0	lib/jsduck/tag/doc.rb
jsduck-5.0.1	lib/jsduck/tag/doc.rb
jsduck-5.0.0	lib/jsduck/tag/doc.rb
jsduck-5.0.0.beta5	lib/jsduck/tag/doc.rb
jsduck-5.0.0.beta4	lib/jsduck/tag/doc.rb
jsduck-5.0.0.beta3	lib/jsduck/tag/doc.rb
jsduck-5.0.0.beta2	lib/jsduck/tag/doc.rb
jsduck-5.0.0.beta01	lib/jsduck/tag/doc.rb