resourceloader: Add missing @private and @protected to mw.loader methods
authorTimo Tijhof <krinklemail@gmail.com>
Thu, 4 Aug 2016 22:45:39 +0000 (15:45 -0700)
committerTimo Tijhof <krinklemail@gmail.com>
Thu, 4 Aug 2016 22:49:29 +0000 (15:49 -0700)
Several local functions were indexed by JSDuck as mw.loader methods whereas
they are in fact they don't even exist on that object. Mark them as @private.

Also add @protected on the internal methods 'work()' and 'require()',
which are public but not for general use (and may change without warning).

Change-Id: If521cc5ae4a565a46161890cf32e95a8c7f4ca50

resources/src/mediawiki/mediawiki.js

index 3600000..ef4f6df 100644 (file)
                         * The CSS will be appended to an existing ResourceLoader-created `<style>` tag
                         * or create a new one based on whether the given `cssText` is safe for extension.
                         *
+                        * @private
                         * @param {string} [cssText=cssBuffer] If called without cssText,
                         *  the internal buffer will be inserted instead.
                         * @param {Function} [callback]
                        }
 
                        /**
-                        * @since 1.26
+                        * @private
                         * @param {Array} modules List of module names
                         * @return {string} Hash of concatenated version hashes.
                         */
                         * size of the startup module. This function changes those dependency lists back to
                         * arrays of strings.
                         *
+                        * @private
                         * @param {Array} modules Modules array
                         */
                        function resolveIndexedDependencies( modules ) {
 
                                /**
                                 * Batch-request queued dependencies from the server.
+                                *
+                                * @protected
                                 */
                                work: function () {
                                        var     reqBase, splits, maxQueryLength, q, b, bSource, bGroup, bSourceGroup,
                                /**
                                 * Get the exported value of a module.
                                 *
-                                * Module provide this value via their local `module.exports`.
+                                * Modules may provide this via their local `module.exports`.
                                 *
+                                * @protected
                                 * @since 1.27
                                 * @return {Array}
                                 */