Jdlrobson has uploaded a new change for review.
https://gerrit.wikimedia.org/r/168001
Change subject: Documentation: Document all the classes
......................................................................
Documentation: Document all the classes
Make sure anything that is in MobileFrontend shows up in the documentation.
Correct a few existing definitions.
Change-Id: Ib63696851e6fe54347554e860d465c5d6fb15bcc
---
M javascripts/modules/issues/CleanupOverlay.js
M javascripts/modules/languages/LanguageOverlay.js
M javascripts/modules/search/SearchApi.js
M javascripts/modules/search/SearchOverlay.js
M javascripts/modules/talk/TalkSectionAddOverlay.js
M javascripts/modules/talk/TalkSectionOverlay.js
M javascripts/modules/toc/toc.js
M javascripts/modules/uploads/LeadPhoto.js
M javascripts/modules/uploads/LeadPhotoUploaderButton.js
M javascripts/modules/uploads/PhotoUploadProgress.js
M javascripts/modules/uploads/UploadTutorial.js
M javascripts/modules/wikigrok/WikiDataApi.js
M javascripts/modules/wikigrok/WikiGrokDialogB.js
M javascripts/specials/mobileoptions.js
M javascripts/specials/uploads.js
15 files changed, 63 insertions(+), 3 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MobileFrontend
refs/changes/01/168001/1
diff --git a/javascripts/modules/issues/CleanupOverlay.js
b/javascripts/modules/issues/CleanupOverlay.js
index f73b49a..d694b24 100644
--- a/javascripts/modules/issues/CleanupOverlay.js
+++ b/javascripts/modules/issues/CleanupOverlay.js
@@ -1,5 +1,9 @@
( function( M ) {
var Overlay = M.require( 'Overlay' ),
+ /**
+ * @class CleanupOverlay
+ * @extends Overlay
+ */
CleanupOverlay = Overlay.extend( {
templatePartials: {
content: M.template.get( 'modules/issues/cleanup.hogan'
)
diff --git a/javascripts/modules/languages/LanguageOverlay.js
b/javascripts/modules/languages/LanguageOverlay.js
index 1e24974..fd00c8f 100644
--- a/javascripts/modules/languages/LanguageOverlay.js
+++ b/javascripts/modules/languages/LanguageOverlay.js
@@ -3,6 +3,10 @@
var Overlay = M.require( 'Overlay' ),
LanguageOverlay;
+ /**
+ * @class LanguageOverlay
+ * @extends Overlay
+ */
LanguageOverlay = Overlay.extend( {
defaults: {
heading: mw.msg( 'mobile-frontend-language-heading' ),
diff --git a/javascripts/modules/search/SearchApi.js
b/javascripts/modules/search/SearchApi.js
index d9a695c..dd5c623 100644
--- a/javascripts/modules/search/SearchApi.js
+++ b/javascripts/modules/search/SearchApi.js
@@ -31,6 +31,10 @@
return label.replace( createSearchRegEx( term
),'<strong>$1</strong>' );
}
+ /**
+ * @class SearchApi
+ * @extends Api
+ */
SearchApi = Api.extend( {
initialize: function() {
Api.prototype.initialize.apply( this, arguments );
diff --git a/javascripts/modules/search/SearchOverlay.js
b/javascripts/modules/search/SearchOverlay.js
index cca085c..d2226ba 100644
--- a/javascripts/modules/search/SearchOverlay.js
+++ b/javascripts/modules/search/SearchOverlay.js
@@ -8,6 +8,10 @@
SEARCH_DELAY = 300,
SearchOverlay;
+ /**
+ * @class SearchOverlay
+ * @extends Overlay
+ */
SearchOverlay = Overlay.extend( {
className: 'overlay search-overlay',
template: M.template.get( 'modules/search/SearchOverlay.hogan'
),
diff --git a/javascripts/modules/talk/TalkSectionAddOverlay.js
b/javascripts/modules/talk/TalkSectionAddOverlay.js
index b420d2a..41fe9f0 100644
--- a/javascripts/modules/talk/TalkSectionAddOverlay.js
+++ b/javascripts/modules/talk/TalkSectionAddOverlay.js
@@ -6,6 +6,10 @@
toast = M.require( 'toast' ),
TalkSectionAddOverlay;
+ /**
+ * @class TalkSectionAddOverlay
+ * @extends Overlay
+ */
TalkSectionAddOverlay = Overlay.extend( {
defaults: {
cancelMsg: mw.msg( 'mobile-frontend-editor-cancel' ),
diff --git a/javascripts/modules/talk/TalkSectionOverlay.js
b/javascripts/modules/talk/TalkSectionOverlay.js
index 607a52d..2c34f82 100644
--- a/javascripts/modules/talk/TalkSectionOverlay.js
+++ b/javascripts/modules/talk/TalkSectionOverlay.js
@@ -4,6 +4,10 @@
popup = M.require( 'toast' ),
api = M.require( 'api' ),
user = M.require( 'user' ),
+ /**
+ * @class TalkSectionOverlay
+ * @extends Overlay
+ */
TalkSectionOverlay = Overlay.extend( {
template: M.template.get( 'modules/talk/talkSection.hogan' ),
templatePartials: {
diff --git a/javascripts/modules/toc/toc.js b/javascripts/modules/toc/toc.js
index 194ae06..cd02313 100644
--- a/javascripts/modules/toc/toc.js
+++ b/javascripts/modules/toc/toc.js
@@ -4,6 +4,10 @@
MobileWebClickTracking = M.require(
'loggingSchemas/MobileWebClickTracking' ),
toggle = M.require( 'toggle' );
+ /**
+ * @class TableOfContents
+ * @extends View
+ */
TableOfContents = View.extend( {
templatePartials: {
tocHeading: M.template.get(
'modules/toc/tocHeading.hogan' )
diff --git a/javascripts/modules/uploads/LeadPhoto.js
b/javascripts/modules/uploads/LeadPhoto.js
index b28959e..74f49a5 100644
--- a/javascripts/modules/uploads/LeadPhoto.js
+++ b/javascripts/modules/uploads/LeadPhoto.js
@@ -2,6 +2,10 @@
var View = M.require( 'View' ), LeadPhoto;
+ /**
+ * @class LeadPhoto
+ * @extends View
+ */
LeadPhoto = View.extend( {
template: M.template.get( 'modules/uploads/LeadPhoto.hogan' ),
diff --git a/javascripts/modules/uploads/LeadPhotoUploaderButton.js
b/javascripts/modules/uploads/LeadPhotoUploaderButton.js
index 2ba3c8f..81eab68 100644
--- a/javascripts/modules/uploads/LeadPhotoUploaderButton.js
+++ b/javascripts/modules/uploads/LeadPhotoUploaderButton.js
@@ -3,6 +3,10 @@
PhotoUploaderButton = M.require(
'modules/uploads/PhotoUploaderButton' ),
LeadPhotoUploaderButton;
+ /**
+ * @class LeadPhotoUploaderButton
+ * @extends PhotoUploaderButton
+ */
LeadPhotoUploaderButton = PhotoUploaderButton.extend( {
template: M.template.get(
'modules/uploads/LeadPhotoUploaderButton.hogan' ),
className: 'enabled',
diff --git a/javascripts/modules/uploads/PhotoUploadProgress.js
b/javascripts/modules/uploads/PhotoUploadProgress.js
index 1675a5e..c3e2721 100644
--- a/javascripts/modules/uploads/PhotoUploadProgress.js
+++ b/javascripts/modules/uploads/PhotoUploadProgress.js
@@ -4,6 +4,10 @@
AbuseFilterPanel = M.require( 'modules/editor/AbuseFilterPanel'
),
PhotoUploadProgress;
+ /**
+ * @class PhotoUploadProgress
+ * @extends Overlay
+ */
PhotoUploadProgress = Overlay.extend( {
defaults: {
uploadingMsg: mw.msg( 'mobile-frontend-image-uploading'
),
diff --git a/javascripts/modules/uploads/UploadTutorial.js
b/javascripts/modules/uploads/UploadTutorial.js
index b383c08..a1a2b13 100644
--- a/javascripts/modules/uploads/UploadTutorial.js
+++ b/javascripts/modules/uploads/UploadTutorial.js
@@ -7,6 +7,10 @@
buttonMsg = mw.msg(
'mobile-frontend-first-upload-wizard-new-page-3-ok' ),
UploadTutorial;
+ /**
+ * @class UploadTutorial
+ * @extends Overlay
+ */
UploadTutorial = Overlay.extend( {
template: M.template.get(
'modules/uploads/UploadTutorial.hogan' ),
className: 'overlay carousel tutorial',
diff --git a/javascripts/modules/wikigrok/WikiDataApi.js
b/javascripts/modules/wikigrok/WikiDataApi.js
index e79bfab..a58bffa 100644
--- a/javascripts/modules/wikigrok/WikiDataApi.js
+++ b/javascripts/modules/wikigrok/WikiDataApi.js
@@ -1,7 +1,7 @@
( function( M, $ ) {
var Api = M.require( 'api' ).Api, WikiDataApi;
/**
- * @class EditorApi
+ * @class WikiDataApi
* @extends Api
*/
WikiDataApi = Api.extend( {
diff --git a/javascripts/modules/wikigrok/WikiGrokDialogB.js
b/javascripts/modules/wikigrok/WikiGrokDialogB.js
index 7990fa0..d610ebc 100644
--- a/javascripts/modules/wikigrok/WikiGrokDialogB.js
+++ b/javascripts/modules/wikigrok/WikiGrokDialogB.js
@@ -5,8 +5,8 @@
WikiGrokDialogB;
/**
- * @class WikiGrokDialog
- * @extends InlineDialog
+ * @class WikiGrokDialogB
+ * @extends WikiGrokDialog
* THIS IS AN EXPERIMENTAL FEATURE THAT MAY BE MOVED TO A SEPARATE
EXTENSION.
* This creates the dialog at the bottom of the lead section that
appears when a user
* scrolls past the lead. It asks the user to confirm metadata
information for use
diff --git a/javascripts/specials/mobileoptions.js
b/javascripts/specials/mobileoptions.js
index ca8782b..d8ba38b 100644
--- a/javascripts/specials/mobileoptions.js
+++ b/javascripts/specials/mobileoptions.js
@@ -1,6 +1,10 @@
( function( M, $ ) {
var View = M.require( 'View' ), Checkbox;
+ /**
+ * @class Checkbox
+ * @extends View
+ */
Checkbox = View.extend( {
template: M.template.get( 'specials/checkbox.hogan' ),
save: function() {
diff --git a/javascripts/specials/uploads.js b/javascripts/specials/uploads.js
index 2a3b758..e115dad 100644
--- a/javascripts/specials/uploads.js
+++ b/javascripts/specials/uploads.js
@@ -12,6 +12,10 @@
IMAGE_WIDTH = mw.config.get( 'wgMFThumbnailSizes' ).medium,
UserGalleryApi, PhotoItem, PhotoList;
+ /**
+ * @class UserGalleryApi
+ * @extends Api
+ */
UserGalleryApi = Api.extend( {
initialize: function() {
Api.prototype.initialize.apply( this, arguments );
@@ -62,11 +66,19 @@
}
} );
+ /**
+ * @class PhotoItem
+ * @extends View
+ */
PhotoItem = View.extend( {
template: M.template.get( 'specials/photo.hogan' ),
tagName: 'li'
} );
+ /**
+ * @class PhotoList
+ * @extends View
+ */
PhotoList = View.extend( {
template: M.template.get( 'specials/userGallery.hogan' ),
templatePartials: {
--
To view, visit https://gerrit.wikimedia.org/r/168001
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib63696851e6fe54347554e860d465c5d6fb15bcc
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/MobileFrontend
Gerrit-Branch: master
Gerrit-Owner: Jdlrobson <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
