From ec6363cf34a3d7d15cd780d8ac07e9f5357b411a Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Thu, 21 Mar 2013 19:45:17 +0100 Subject: [PATCH] JSDuck: Cover more of external.js and implement @source Taken from VisualEditor repo (authored by myself under MIT). Hereby released under GPL as well. Change-Id: I4dc1a0e5c618e0a20ae6f308b4ecf266d041e22c --- maintenance/jsduck/MetaTags.rb | 16 ++++++++++++++++ maintenance/jsduck/categories.json | 12 ++++++------ maintenance/jsduck/external.js | 17 +++++++++++++++++ 3 files changed, 39 insertions(+), 6 deletions(-) diff --git a/maintenance/jsduck/MetaTags.rb b/maintenance/jsduck/MetaTags.rb index 84e4021339..83cc0884ce 100644 --- a/maintenance/jsduck/MetaTags.rb +++ b/maintenance/jsduck/MetaTags.rb @@ -3,6 +3,22 @@ # - https://github.com/senchalabs/jsduck/wiki/Custom-tags require 'jsduck/meta_tag' +class SourceTag < JsDuck::MetaTag + def initialize + # This defines the name of the @tag + @name = 'source' + end + + # Generate HTML output for this tag. + # One can make use of the #format method to easily support + # Markdown and {@link} tags inside the contents of the tag. + # + # @param tags All matches of this tag on one class. + def to_html(tags) + '

Source

' + tags.map {|tag| format(tag) }.join("\n") + end +end + class ContextTag < JsDuck::MetaTag def initialize @name = 'context' diff --git a/maintenance/jsduck/categories.json b/maintenance/jsduck/categories.json index 4a8ba8c3bb..c29c91c9b5 100644 --- a/maintenance/jsduck/categories.json +++ b/maintenance/jsduck/categories.json @@ -32,10 +32,6 @@ { "name": "jQuery", "groups": [ - { - "name": "Core", - "classes": ["jQuery", "jQuery.Event", "jQuery.Promise", "jQuery.Deferred", "jQuery.jqXHR"] - }, { "name": "Plugins", "classes": ["jQuery.plugin.*"] @@ -43,10 +39,14 @@ ] }, { - "name": "Misc", + "name": "Upstream", "groups": [ { - "name": "Native", + "name": "jQuery", + "classes": ["jQuery", "jQuery.Event", "jQuery.Callbacks", "jQuery.Promise", "jQuery.Deferred", "jQuery.jqXHR", "QUnit"] + }, + { + "name": "JavaScript", "classes": ["Array", "Boolean", "Date", "Function", "Number", "Object", "RegExp", "String"] } ] diff --git a/maintenance/jsduck/external.js b/maintenance/jsduck/external.js index 8ab102f4c3..7910ec8d6b 100644 --- a/maintenance/jsduck/external.js +++ b/maintenance/jsduck/external.js @@ -1,26 +1,43 @@ /** * @class jQuery + * @source */ /** * @method ajax + * @source * @return {jqXHR} */ /** * @class jQuery.Event + * @source + */ + +/** + * @class jQuery.Callbacks + * @source */ /** * @class jQuery.Promise + * @source */ /** * @class jQuery.Deferred * @mixins jQuery.Promise + * @source */ /** * @class jQuery.jqXHR + * @source * @alternateClassName jqXHR */ + + +/** + * @class QUnit + * @source + */ -- 2.20.1