# Custom tags for JSDuck 5.x
# See also:
# - https://github.com/senchalabs/jsduck/wiki/Tags
# - https://github.com/senchalabs/jsduck/wiki/Custom-tags
# - https://github.com/senchalabs/jsduck/wiki/Custom-tags/7f5c32e568eab9edc8e3365e935bcb836cb11f1d
require 'jsduck/tag/tag'
class CommonTag < JsDuck::Tag::Tag
def initialize
@html_position = POS_DOC + 0.1
@repeatable = true
end
def parse_doc(scanner, _position)
if @multiline
return { tagname: @tagname, doc: :multiline }
else
text = scanner.match(/.*$/)
return { tagname: @tagname, doc: text }
end
end
def process_doc(context, tags, _position)
context[@tagname] = tags
end
def format(context, formatter)
context[@tagname].each do |tag|
tag[:doc] = formatter.format(tag[:doc])
end
end
end
class SourceTag < CommonTag
def initialize
@tagname = :source
@pattern = 'source'
super
end
def to_html(context)
context[@tagname].map do |source|
<<-EOHTML
Source
#{source[:doc]}
EOHTML
end.join
end
end
class SeeTag < CommonTag
def initialize
@tagname = :see
@pattern = 'see'
super
end
def format(context, formatter)
position = context[:files][0]
context[@tagname].each do |tag|
tag[:doc] = '' + render_long_see(tag[:doc], formatter, position) + ''
end
end
def to_html(context)
<<-EOHTML
Related
#{ context[@tagname].map { |tag| tag[:doc] }.join("\n") }
EOHTML
end
def render_long_see(tag, formatter, position)
match = /\A([^\s]+)( .*)?\Z/m.match(tag)
if match
name = match[1]
doc = match[2] ? ': ' + match[2] : ''
return formatter.format("{@link #{name}} #{doc}")
else
JsDuck::Logger.warn(nil, 'Unexpected @see argument: "' + tag + '"', position)
return tag
end
end
end
class ContextTag < CommonTag
def initialize
@tagname = :context
@pattern = 'context'
super
end
def format(context, formatter)
position = context[:files][0]
context[@tagname].each do |tag|
tag[:doc] = render_long_context(tag[:doc], formatter, position)
end
end
def to_html(context)
<<-EOHTML
Context
#{ context[@tagname].last[:doc] }
EOHTML
end
def render_long_context(tag, formatter, position)
match = /\A([^\s]+)/m.match(tag)
if match
name = match[1]
return formatter.format("`context` : {@link #{name}}")
else
JsDuck::Logger.warn(nil, 'Unexpected @context argument: "' + tag + '"', position)
return tag
end
end
end