jsduck: Remove broken url from custom_tags.rb

[lhc/web/wiklou.git] / maintenance / jsduck / custom_tags.rb

diff --git a/maintenance/jsduck/custom_tags.rb b/maintenance/jsduck/custom_tags.rb
index 2de3ac0..33008d1 100644 (file)
--- a/maintenance/jsduck/custom_tags.rb
+++ b/maintenance/jsduck/custom_tags.rb
@@ -1,6 +1,5 @@
 # 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'
@@ -11,16 +10,16 @@ class CommonTag < JsDuck::Tag::Tag
     @repeatable = true
   end
 
-  def parse_doc(scanner, position)
+  def parse_doc(scanner, _position)
     if @multiline
-      return { :tagname => @tagname, :doc => :multiline }
+      return { tagname: @tagname, doc: :multiline }
     else
       text = scanner.match(/.*$/)
-      return { :tagname => @tagname, :doc => text }
+      return { tagname: @tagname, doc: text }
     end
   end
 
-  def process_doc(context, tags, position)
+  def process_doc(context, tags, _position)
     context[@tagname] = tags
   end
 
@@ -34,7 +33,7 @@ end
 class SourceTag < CommonTag
   def initialize
     @tagname = :source
-    @pattern = "source"
+    @pattern = 'source'
     super
   end
 
@@ -51,7 +50,7 @@ end
 class SeeTag < CommonTag
   def initialize
     @tagname = :see
-    @pattern = "see"
+    @pattern = 'see'
     super
   end
 
@@ -66,15 +65,17 @@ class SeeTag < CommonTag
     <<-EOHTML
       <h3 class="pa">Related</h3>
       <ul>
-      #{ context[@tagname].map { |tag| tag[:doc] }.join("\n") }
+      #{context[@tagname].map { |tag| tag[:doc] }.join("\n")}
       </ul>
     EOHTML
   end
 
   def render_long_see(tag, formatter, position)
-    if tag =~ /\A([^\s]+)( .*)?\Z/m
-      name = $1
-      doc = $2 ? ': ' + $2 : ''
+    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)
@@ -100,13 +101,15 @@ class ContextTag < CommonTag
   def to_html(context)
     <<-EOHTML
       <h3 class="pa">Context</h3>
-      #{ context[@tagname].last[:doc] }
+      #{context[@tagname].last[:doc]}
     EOHTML
   end
 
   def render_long_context(tag, formatter, position)
-    if tag =~ /\A([^\s]+)/m
-      name = $1
+    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)