Jdlrobson has uploaded a new change for review.
https://gerrit.wikimedia.org/r/169235
Change subject: Add document to Class, EventEmitter and mantle
......................................................................
Add document to Class, EventEmitter and mantle
Change-Id: I3eae61ae185a0a223049665c376dd61bccf767d0
---
M javascripts/common/Class.js
M javascripts/common/eventemitter.js
M javascripts/common/main.js
3 files changed, 9 insertions(+), 1 deletion(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Mantle
refs/changes/35/169235/1
diff --git a/javascripts/common/Class.js b/javascripts/common/Class.js
index 82885cd..0448ac8 100644
--- a/javascripts/common/Class.js
+++ b/javascripts/common/Class.js
@@ -6,7 +6,7 @@
/**
* Extends a class with new methods and member properties.
*
- * @param {Object} prototype
+ * @param {Object} prototype Prototype that should be incorporated into
the new Class.
* @method
* @return {Class}
*/
@@ -25,6 +25,11 @@
return Child;
}
+ /**
+ * An extensible program-code-template for creating objects
+ *
+ * @class Class
+ */
function Class() {
this.initialize.apply( this, arguments );
}
diff --git a/javascripts/common/eventemitter.js
b/javascripts/common/eventemitter.js
index 3e2bce2..4892463 100644
--- a/javascripts/common/eventemitter.js
+++ b/javascripts/common/eventemitter.js
@@ -7,6 +7,7 @@
// and Mantle's different OO models get along,
// and we need to alias one() to once().
/**
+ * A base class with support for event emitting.
* @class EventEmitter
* @extends Class
* @uses OO.EventEmitter
diff --git a/javascripts/common/main.js b/javascripts/common/main.js
index 36ca30b..6c7db17 100644
--- a/javascripts/common/main.js
+++ b/javascripts/common/main.js
@@ -1,4 +1,6 @@
/**
+ * A wrapper for methods and utility functions who's code is not yet stable
enough to be incorporated
+ * into MediaWiki core.
* @singleton
* @class mw.mantle
*/
--
To view, visit https://gerrit.wikimedia.org/r/169235
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I3eae61ae185a0a223049665c376dd61bccf767d0
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Mantle
Gerrit-Branch: master
Gerrit-Owner: Jdlrobson <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
