jenkins-bot has submitted this change and it was merged. Change subject: Document incomplete methods and classes. ......................................................................
Document incomplete methods and classes. Change-Id: I4d9249b5a16b7ea1e415fe89e06b2775e3658ca7 --- M javascripts/common/Class.js M javascripts/common/View.js M javascripts/common/eventemitter.js M javascripts/common/main.js 4 files changed, 11 insertions(+), 1 deletion(-) Approvals: Robmoen: Looks good to me, approved Jdlrobson: Looks good to me, approved jenkins-bot: Verified 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/View.js b/javascripts/common/View.js index c929a00..4534a89 100644 --- a/javascripts/common/View.js +++ b/javascripts/common/View.js @@ -47,6 +47,7 @@ */ View = EventEmitter.extend( { /** + * Name of tag that contains the rendered template * @type String */ tagName: 'div', @@ -83,6 +84,7 @@ defaults: {}, /** + * Run once during construction to set up the View * @method * @param {Object} options Object passed to the constructor. */ diff --git a/javascripts/common/eventemitter.js b/javascripts/common/eventemitter.js index b7eebec..84b0a66 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/169234 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I4d9249b5a16b7ea1e415fe89e06b2775e3658ca7 Gerrit-PatchSet: 4 Gerrit-Project: mediawiki/extensions/Mantle Gerrit-Branch: master Gerrit-Owner: Jdlrobson <jrob...@wikimedia.org> Gerrit-Reviewer: Jdlrobson <jrob...@wikimedia.org> Gerrit-Reviewer: Robmoen <rm...@wikimedia.org> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits