Bartosz Dziewoński has uploaded a new change for review.

  https://gerrit.wikimedia.org/r/120794

Change subject: mediawiki.js: Fix docucumentation breakage
......................................................................

mediawiki.js: Fix docucumentation breakage

* Unformatted code and unclosed <media> tag.
  Depending on which versions of other libs are installed, this
  error can occur. Current version (v4.x) in production doesn't
  require this yet. But local environment with the same version
  does. And the next version of jsduck (v5.x) will consistently
  work this way for compliance with Markdown.

* Simplified @link while at it to use the cleaner implied link
  instead like we do elsewhere ({@link} should rarely be
  used directly).

* Add /** @class */ because half the file was no longer indexed
  as part of mw (instead became part of mw.Message after 4f23099)

* Index the private mw#log as log_ instead because it clashes
  with the public mw#log. This should've clashed in 4f23099, but
  didn't because the other one was seen as part of mw.Message
  by the test.

Change-Id: Ic5b8c5c743ecdb1509652c3655d83e501f6fa9ee
(cherry picked from commit 176e3e44a01dc5d5b020f276649123d743458d8f)
---
M resources/mediawiki/mediawiki.js
1 file changed, 8 insertions(+), 1 deletion(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core 
refs/changes/94/120794/1

diff --git a/resources/mediawiki/mediawiki.js b/resources/mediawiki/mediawiki.js
index 80223e5..5a4ff1b 100644
--- a/resources/mediawiki/mediawiki.js
+++ b/resources/mediawiki/mediawiki.js
@@ -21,6 +21,7 @@
         * fine. No need for optimization here, which would only result in 
losing logs.
         *
         * @private
+        * @method log_
         * @param {string} msg text for the log entry.
         * @param {Error} [e]
         */
@@ -318,6 +319,9 @@
                }
        };
 
+       /**
+        * @class mw
+        */
        return {
                /* Public Members */
 
@@ -1446,16 +1450,19 @@
                                 * @param {Function|Array} script Function with 
module code or Array of URLs to
                                 *  be used as the src attribute of a new 
`<script>` tag.
                                 * @param {Object} style Should follow one of 
the following patterns:
+                                *
                                 *     { "css": [css, ..] }
                                 *     { "url": { <media>: [url, ..] } }
+                                *
                                 * And for backwards compatibility (needs to be 
supported forever due to caching):
+                                *
                                 *     { <media>: css }
                                 *     { <media>: [url, ..] }
                                 *
                                 * The reason css strings are not concatenated 
anymore is bug 31676. We now check
                                 * whether it's safe to extend the stylesheet 
(see #canExpandStylesheetWith).
                                 *
-                                * @param {Object} msgs List of key/value pairs 
to be added to {@link mw#messages}.
+                                * @param {Object} msgs List of key/value pairs 
to be added to mw#messages.
                                 */
                                implement: function ( module, script, style, 
msgs ) {
                                        // Validate input

-- 
To view, visit https://gerrit.wikimedia.org/r/120794
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ic5b8c5c743ecdb1509652c3655d83e501f6fa9ee
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: REL1_22
Gerrit-Owner: Bartosz Dziewoński <[email protected]>
Gerrit-Reviewer: Krinkle <[email protected]>

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to