Merge "mediawiki.log: Add to jsduck index"

diff --git a/maintenance/jsduck/categories.json b/maintenance/jsduck/categories.json
index c29c91c..7e7b381 100644 (file)
--- a/maintenance/jsduck/categories.json
+++ b/maintenance/jsduck/categories.json
@@ -20,7 +20,7 @@
                                        "mw.Title",
                                        "mw.notification",
                                        "mw.util",
-                                       "mw.plugin.notify"
+                                       "mw.plugin.*"
                                ]
                        },
                        {

diff --git a/maintenance/jsduck/config.json b/maintenance/jsduck/config.json
index e932b5c..4ad75f0 100644 (file)
--- a/maintenance/jsduck/config.json
+++ b/maintenance/jsduck/config.json
@@ -9,6 +9,7 @@
        "--": [
                "./external.js",
                "../../resources/mediawiki/mediawiki.js",
+               "../../resources/mediawiki/mediawiki.log.js",
                "../../resources/mediawiki/mediawiki.util.js",
                "../../resources/mediawiki/mediawiki.Title.js",
                "../../resources/mediawiki/mediawiki.notify.js",

diff --git a/resources/mediawiki/mediawiki.log.js b/resources/mediawiki/mediawiki.log.js
index ee08b12..e94f37c 100644 (file)
--- a/resources/mediawiki/mediawiki.log.js
+++ b/resources/mediawiki/mediawiki.log.js
@@ -1,4 +1,4 @@
-/**
+/*!
  * Logger for MediaWiki javascript.
  * Implements the stub left by the main 'mediawiki' module.
  *
@@ -8,16 +8,20 @@
 
 ( function ( mw, $ ) {
 
+       /**
+        * @class mw.plugin.log
+        */
+
        /**
         * Logs a message to the console.
         *
         * In the case the browser does not have a console API, a console is created on-the-fly by appending
-        * a <div id="mw-log-console"> element to the bottom of the body and then appending this and future
+        * a `<div id="mw-log-console">` element to the bottom of the body and then appending this and future
         * messages to that, instead of the console.
         *
-        * @param {String} First in list of variadic messages to output to console.
+        * @param {string...} msg Messages to output to console.
         */
-       mw.log = function ( /* logmsg, logmsg, */ ) {
+       mw.log = function () {
                // Turn arguments into an array
                var     args = Array.prototype.slice.call( arguments ),
                        // Allow log messages to use a configured prefix to identify the source window (ie. frame)
@@ -68,4 +72,9 @@
                } );
        };
 
+       /**
+        * @class mw
+        * @mixins mw.plugin.log
+        */
+
 }( mediaWiki, jQuery ) );