From: Timo Tijhof <krinklemail@gmail.com>
Date: Fri, 10 Jan 2014 22:14:18 +0000 (+0100)
Subject: Add OOjs to jsduck index
X-Git-Tag: 1.31.0-rc.0~17244
X-Git-Url: http://git.cyclocoop.org//%27%40script%40/%27?a=commitdiff_plain;h=f7ad294e9fdd05c9c766ddd5451bd3d86cdcfc07;p=lhc%2Fweb%2Fwiklou.git

Add OOjs to jsduck index

Change-Id: I7ced3673a0a09ea0f37b59729318f02e52fe1340
---

diff --git a/maintenance/jsduck/MetaTags.rb b/maintenance/jsduck/MetaTags.rb
index 83cc0884ce..cde7d3b7f4 100644
--- a/maintenance/jsduck/MetaTags.rb
+++ b/maintenance/jsduck/MetaTags.rb
@@ -1,6 +1,8 @@
+# Custom tags for JSDuck 4.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/meta_tag'
 
 class SourceTag < JsDuck::MetaTag
@@ -67,3 +69,35 @@ class SeeTag < JsDuck::MetaTag
     end
   end
 end
+
+# As of JSDuck 5 this is in core
+class FiresTag < JsDuck::MetaTag
+  def initialize
+    @name = 'fires'
+    @multiline = true
+  end
+
+  # @param tags All matches of this tag on one class.
+  def to_html(tags)
+    doc = []
+    doc << '<h3 class="pa">Fires</h3>'
+    doc << [
+        '<ul>',
+        tags.map {|tag| render_long_event(tag) },
+        '</ul>',
+      ]
+    doc
+  end
+
+  def render_long_event(tag)
+    if tag =~ /\A(\w+)( .*)?\Z/m
+      name = $1
+      doc = $2 ? ': ' + $2 : ''
+      return [
+        '<li>',
+        format("{@link #event-#{name}} #{doc}"),
+        '</li>'
+      ]
+    end
+  end
+end
diff --git a/maintenance/jsduck/categories.json b/maintenance/jsduck/categories.json
index c595980515..d38ea5b72e 100644
--- a/maintenance/jsduck/categories.json
+++ b/maintenance/jsduck/categories.json
@@ -51,6 +51,10 @@
 	{
 		"name": "Upstream",
 		"groups": [
+			{
+				"name": "OOJS",
+				"classes": ["OO", "OO.*"]
+			},
 			{
 				"name": "jQuery",
 				"classes": ["jQuery", "jQuery.Event", "jQuery.Callbacks", "jQuery.Promise", "jQuery.Deferred", "jQuery.jqXHR", "QUnit"]
diff --git a/maintenance/jsduck/config.json b/maintenance/jsduck/config.json
index e6e0f65875..70b7a9e56f 100644
--- a/maintenance/jsduck/config.json
+++ b/maintenance/jsduck/config.json
@@ -22,6 +22,7 @@
 		"../../resources/mediawiki.page/mediawiki.page.startup.js",
 		"../../resources/mediawiki.api",
 		"../../resources/jquery/jquery.localize.js",
-		"../../resources/jquery/jquery.spinner.js"
+		"../../resources/jquery/jquery.spinner.js",
+		"../../resources/oojs"
 	]
 }