class JsDuck::Tag::Required
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.
Public Class Methods
new()
click to toggle source
# File lib/jsduck/tag/required.rb, line 13 def initialize @tagname = :required @signature = {:long => "required", :short => "REQ"} @css = ".signature .required { background-color: #484848 }" # Docs text color end
Public Instance Methods
process_doc(h, docs, pos)
click to toggle source
# File lib/jsduck/tag/required.rb, line 19 def process_doc(h, docs, pos) h[:required] = true end