Sha256: fe3d70551db454a66989577abc591460808bb3509c2ea269c088aad6cad760ce

Contents?: true

Size: 668 Bytes

Versions: 30

Compression:

Stored size: 668 Bytes

Contents

require "jsduck/tag/tag"

module JsDuck::Tag
  # There is no @required tag.
  # Instead the :required attribute is detected after @cfg:
  #
  #    @cfg {Type} someName (required)
  #
  # This class is only used for rendering the required attribute in
  # HTML documentation, not for detecting it.  The detection is done
  # with custom logic in @cfg and DocAst classes.
  class Required < Tag
    def initialize
      @tagname = :required
      @signature = {:long => "required", :short => "REQ"}
      @css = ".signature .required { background-color: #484848 }" # Docs text color
    end

    def process_doc(h, docs, pos)
      h[:required] = true
    end
  end
end

Version data entries

30 entries across 30 versions & 3 rubygems

Version Path
solvas-jsduck-6.0.0.30539 lib/jsduck/tag/required.rb
solvas-jsduck-6.0.0.9571 lib/jsduck/tag/required.rb
solvas-jsduck-6.0.0.6154 lib/jsduck/tag/required.rb
solvas-jsduck-6.0.0.4021 lib/jsduck/tag/required.rb
solvas-jsduck-6.0.0.2554 lib/jsduck/tag/required.rb
solvas-jsduck-6.0.0.1891 lib/jsduck/tag/required.rb
solvas-jsduck-6.0.0.beta.1888 lib/jsduck/tag/required.rb
jsduck-troopjs-0.0.10 lib/jsduck/tag/required.rb
jsduck-troopjs-0.0.9 lib/jsduck/tag/required.rb
jsduck-troopjs-0.0.8 lib/jsduck/tag/required.rb
jsduck-troopjs-0.0.7 lib/jsduck/tag/required.rb
jsduck-troopjs-0.0.5 lib/jsduck/tag/required.rb
jsduck-troopjs-0.0.4 lib/jsduck/tag/required.rb
jsduck-troopjs-0.0.3 lib/jsduck/tag/required.rb
jsduck-troopjs-0.0.1 lib/jsduck/tag/required.rb
jsduck-6.0.0beta lib/jsduck/tag/required.rb
jsduck-5.3.4 lib/jsduck/tag/required.rb
jsduck-5.3.3 lib/jsduck/tag/required.rb
jsduck-5.3.2 lib/jsduck/tag/required.rb
jsduck-5.3.1 lib/jsduck/tag/required.rb