jenkins-bot has submitted this change and it was merged.
Change subject: Documentation: Editor files and Toast
......................................................................
Documentation: Editor files and Toast
Change-Id: I096aba27ffa767b1d9247c4bc80797bbc5038d35
---
M javascripts/modules/editor/AbuseFilterOverlay.js
M javascripts/modules/editor/AbuseFilterPanel.js
M javascripts/modules/editor/EditorApi.js
M javascripts/modules/editor/EditorOverlay.js
M javascripts/modules/editor/EditorOverlayBase.js
M javascripts/toast.js
6 files changed, 15 insertions(+), 0 deletions(-)
Approvals:
Jdlrobson: Looks good to me, approved
jenkins-bot: Verified
diff --git a/javascripts/modules/editor/AbuseFilterOverlay.js
b/javascripts/modules/editor/AbuseFilterOverlay.js
index 3c3c5fb..942448d 100644
--- a/javascripts/modules/editor/AbuseFilterOverlay.js
+++ b/javascripts/modules/editor/AbuseFilterOverlay.js
@@ -1,5 +1,11 @@
( function ( M ) {
var Overlay = M.require( 'Overlay' ), AbuseFilterOverlay;
+ /**
+ * Overlay that shows a message about abuse. This overlay is rendered
when the error code from the API
+ * is related to the abusefilter extension.
+ * @class AbuseFilterOverlay
+ * @extends Overlay
+ */
AbuseFilterOverlay = Overlay.extend( {
defaults: {
confirmMessage: mw.msg(
'mobile-frontend-photo-ownership-confirm' )
diff --git a/javascripts/modules/editor/AbuseFilterPanel.js
b/javascripts/modules/editor/AbuseFilterPanel.js
index e42c132..8dbc025 100644
--- a/javascripts/modules/editor/AbuseFilterPanel.js
+++ b/javascripts/modules/editor/AbuseFilterPanel.js
@@ -4,6 +4,11 @@
AbuseFilterOverlay = M.require(
'modules/editor/AbuseFilterOverlay' ),
AbuseFilterPanel;
+ /**
+ * Panel that shows an error message related to the abusefilter
extension.
+ * @class AbuseFilterPanel
+ * @extends View
+ */
AbuseFilterPanel = View.extend( {
defaults: {
readMoreMsg: mw.msg(
'mobile-frontend-editor-abusefilter-read-more')
diff --git a/javascripts/modules/editor/EditorApi.js
b/javascripts/modules/editor/EditorApi.js
index a092271..dd8b6ec 100644
--- a/javascripts/modules/editor/EditorApi.js
+++ b/javascripts/modules/editor/EditorApi.js
@@ -1,6 +1,7 @@
( function( M, $ ) {
var Api = M.require( 'api' ).Api, EditorApi;
/**
+ * API that helps save and retrieve page content
* @class EditorApi
* @extends Api
*/
diff --git a/javascripts/modules/editor/EditorOverlay.js
b/javascripts/modules/editor/EditorOverlay.js
index 0fc6152..6f3562b 100644
--- a/javascripts/modules/editor/EditorOverlay.js
+++ b/javascripts/modules/editor/EditorOverlay.js
@@ -11,6 +11,7 @@
EditorOverlay;
/**
+ * Overlay that shows an editor
* @class EditorOverlay
* @extends EditorOverlayBase
*/
diff --git a/javascripts/modules/editor/EditorOverlayBase.js
b/javascripts/modules/editor/EditorOverlayBase.js
index 5625366..403b238 100644
--- a/javascripts/modules/editor/EditorOverlayBase.js
+++ b/javascripts/modules/editor/EditorOverlayBase.js
@@ -6,6 +6,7 @@
EditorOverlayBase;
/**
+ * Base class for EditorOverlay
* @extends Overlay
* @class EditorOverlayBase
*/
diff --git a/javascripts/toast.js b/javascripts/toast.js
index eb66c8d..76c59dd 100644
--- a/javascripts/toast.js
+++ b/javascripts/toast.js
@@ -2,6 +2,7 @@
var Drawer = M.require( 'Drawer' ), Toast;
/**
+ * Auto-expiring notification.
* @class
* @extends Drawer
*/
--
To view, visit https://gerrit.wikimedia.org/r/165257
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I096aba27ffa767b1d9247c4bc80797bbc5038d35
Gerrit-PatchSet: 4
Gerrit-Project: mediawiki/extensions/MobileFrontend
Gerrit-Branch: master
Gerrit-Owner: Bmansurov <bmansu...@wikimedia.org>
Gerrit-Reviewer: Awjrichards <aricha...@wikimedia.org>
Gerrit-Reviewer: JGonera <jgon...@wikimedia.org>
Gerrit-Reviewer: Jdlrobson <jrob...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
