r93016 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r93015‎ | r93016 | r93017 >
Date:21:36, 24 July 2011
Author:krinkle
Status:ok
Tags:
Comment:
Adding documentation for mw.loader.register
Modified paths:
  • /trunk/phase3/resources/mediawiki/mediawiki.js (modified) (history)

Diff [purge]

Index: trunk/phase3/resources/mediawiki/mediawiki.js
@@ -838,7 +838,13 @@
839839
840840 /**
841841 * Registers a module, letting the system know about it and its
842 - * dependencies. loader.js files contain calls to this function.
 842+ * properties. Startup modules contain calls to this function.
 843+ *
 844+ * @param module {String}: Module name
 845+ * @param version {Number}: Module version number as a timestamp (falls backs to 0)
 846+ * @param dependencies {String|Array|Function}: One string or array of strings of module
 847+ * names on which this module depends, or a function that returns that array.
 848+ * @param group {String}: Group which the module is in (optional, defaults to null)
843849 */
844850 this.register = function( module, version, dependencies, group ) {
845851 // Allow multiple registration

Status & tagging log