Jhernandez has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/357202 )
Change subject: POC: JSDoc Docstrap template and other tests
......................................................................
POC: JSDoc Docstrap template and other tests
* Events w/ dots on name
* singletons with the same name as class on the same namespace
Change-Id: I62677c37e3c2fdb63ab1be0572f32549c90aca69
---
M package.json
M resources/mobile.abusefilter/AbuseFilterOverlay.js
2 files changed, 46 insertions(+), 28 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MobileFrontend
refs/changes/02/357202/1
diff --git a/package.json b/package.json
index d00c753..73f6375 100644
--- a/package.json
+++ b/package.json
@@ -1,25 +1,26 @@
{
- "private": true,
- "scripts": {
- "test": "grunt test && npm run doc && dev-scripts/svg_check.sh",
- "doc": "npm run jsdoc",
- "jsdoc": "jsdoc -r resources -d docs/ -c .jsdoc.json",
- "lint:modules": "resource-modules ./"
- },
- "dependencies": {
- "jsdoc": "3.4.2",
- "svgo": ">=0.4.4"
- },
- "devDependencies": {
- "eslint-config-wikimedia": "0.4.0",
- "grunt": "^1.0.1",
- "grunt-banana-checker": "^0.5.0",
- "grunt-contrib-watch": "^1.0.0",
- "grunt-eslint": "19.0.0",
- "grunt-jsonlint": "^1.1.0",
- "grunt-notify": "^0.4.5",
- "grunt-stylelint": "^0.6.0",
- "resource-modules": "^1.0.17",
- "stylelint-config-wikimedia": "^0.3.0"
- }
+ "private": true,
+ "scripts": {
+ "test": "grunt test && npm run doc && dev-scripts/svg_check.sh",
+ "doc": "npm run jsdoc",
+ "jsdoc": "jsdoc -r resources -d docs/ -c .jsdoc.json -t
./node_modules/ink-docstrap/template -R README.md",
+ "lint:modules": "resource-modules ./"
+ },
+ "dependencies": {
+ "jsdoc": "3.4.2",
+ "svgo": ">=0.4.4"
+ },
+ "devDependencies": {
+ "eslint-config-wikimedia": "0.4.0",
+ "grunt": "^1.0.1",
+ "grunt-banana-checker": "^0.5.0",
+ "grunt-contrib-watch": "^1.0.0",
+ "grunt-eslint": "19.0.0",
+ "grunt-jsonlint": "^1.1.0",
+ "grunt-notify": "^0.4.5",
+ "grunt-stylelint": "^0.6.0",
+ "ink-docstrap": "^1.3.0",
+ "resource-modules": "^1.0.17",
+ "stylelint-config-wikimedia": "^0.3.0"
+ }
}
diff --git a/resources/mobile.abusefilter/AbuseFilterOverlay.js
b/resources/mobile.abusefilter/AbuseFilterOverlay.js
index 5a97e88..788c319 100644
--- a/resources/mobile.abusefilter/AbuseFilterOverlay.js
+++ b/resources/mobile.abusefilter/AbuseFilterOverlay.js
@@ -3,20 +3,22 @@
Overlay = M.require( 'mobile.startup/Overlay' );
/**
+ * @classdesc
* 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
+ *
+ * @constructor
*/
function AbuseFilterOverlay() {
Overlay.apply( this, arguments );
}
- OO.mfExtend( AbuseFilterOverlay, Overlay, {
+ OO.mfExtend( AbuseFilterOverlay, Overlay, /** @lends
AbuseFilterOverlay.prototype */ {
/**
- * @inheritdoc
- * @cfg {Object} defaults Default options hash.
- * @cfg {Object} defaults.confirmButton options for a confirm
Button
+ * @property {Object} defaults Default options hash.
+ * @property {Object} defaults.confirmButton options for a
confirm Button
*/
defaults: $.extend( {}, Overlay.prototype.defaults, {
confirmButton: new Button( {
@@ -30,13 +32,28 @@
} ),
className: 'overlay abusefilter-overlay',
- /** @inheritdoc */
+ /**
+ * @fires AbuseFilterOverlay#"snowball.banana"
+ */
postRender: function () {
Overlay.prototype.postRender.apply( this );
// make links open in separate tabs
+ /**
+ * Snowball event
+ * @event AbuseFilterOverlay#"snowball.banana"
+ * @type {object}
+ * @property {boolean} isPacked - Indicates whether the
snowball is tightly packed.
+ */
this.$( 'a' ).attr( 'target', '_blank' );
}
} );
M.define( 'mobile.abusefilter/AbuseFilterOverlay', AbuseFilterOverlay );
}( mw.mobileFrontend, jQuery ) );
+
+/** @namespace */
+var testNS = {};
+/** @class */
+testNS.Banana = function () {};
+/** @property {Banana} banana singleton of {@link testNS.Banana}*/
+testNS.banana = new testNS.Banana();
--
To view, visit https://gerrit.wikimedia.org/r/357202
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I62677c37e3c2fdb63ab1be0572f32549c90aca69
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/MobileFrontend
Gerrit-Branch: master
Gerrit-Owner: Jhernandez <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
