jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/365046 )
Change subject: Add tooling for documentation
......................................................................
Add tooling for documentation
* Add global View and Page
* Remove inheritdoc statements for globals - docs
cannot be inherited from a class defined in another repo
Note:
you'll need to `gem install jsduck` for this to work
Bug: T170639
Change-Id: Idb3a6e9edbd45889047e7904561b84033569a689
---
A jsduck.json
M package.json
M resources/skins.minerva.mainMenu/MainMenu.js
M resources/skins.minerva.notifications.badge/NotificationBadge.js
4 files changed, 37 insertions(+), 10 deletions(-)
Approvals:
Pmiazga: Looks good to me, approved
jenkins-bot: Verified
Jdlrobson: Looks good to me, approved
diff --git a/jsduck.json b/jsduck.json
new file mode 100644
index 0000000..d1938ea
--- /dev/null
+++ b/jsduck.json
@@ -0,0 +1,34 @@
+{
+ "--title": "MinervaNeue - Documentation",
+ "--output": "docs",
+ "--processes": "0",
+ "--warnings-exit-nonzero": true,
+ "--builtin-classes": true,
+ "--external": [
+ "Hogan.Template",
+ "HandleBars.Template",
+ "jQuery.Deferred",
+ "jQuery.Promise",
+ "jQuery.Event",
+ "jQuery.Object",
+ "jqXHR",
+ "View",
+ "Page",
+ "File",
+ "Router",
+ "MainMenu",
+ "mw.user",
+ "mw.Api",
+ "mw.ForeignApi",
+ "OO.ui.ToolGroup",
+ "OO.ui.Tool",
+ "OO.ui.mixin.LookupElement",
+ "OO.EventEmitter",
+ "ve.init.mw.MobileArticleTarget",
+ "mw.echo.dm.NotificationItem"
+ ],
+ "--warnings": ["-nodoc(class,public)", "-dup_member",
"-link_ambiguous"],
+ "--": [
+ "resources"
+ ]
+}
diff --git a/package.json b/package.json
index 7184a14..48f00c9 100644
--- a/package.json
+++ b/package.json
@@ -1,9 +1,11 @@
{
"private": true,
"scripts": {
- "test": "grunt test && dev-scripts/svg_check.sh"
+ "test": "grunt test && npm run doc && dev-scripts/svg_check.sh",
+ "doc": "jsduck"
},
"dependencies": {
+ "jsdoc": "3.4.2",
"svgo": ">=0.4.4"
},
"devDependencies": {
diff --git a/resources/skins.minerva.mainMenu/MainMenu.js
b/resources/skins.minerva.mainMenu/MainMenu.js
index babda9b..4b51e40 100644
--- a/resources/skins.minerva.mainMenu/MainMenu.js
+++ b/resources/skins.minerva.mainMenu/MainMenu.js
@@ -17,11 +17,8 @@
}
OO.mfExtend( MainMenu, View, {
- /** @inheritdoc */
isTemplateMode: true,
- /** @inheritdoc */
template: mw.template.get( 'skins.minerva.mainMenu',
'menu.hogan' ),
- /** @inheritdoc */
templatePartials: {
menuGroup: mw.template.get( 'skins.minerva.mainMenu',
'menuGroup.hogan' )
},
@@ -51,7 +48,6 @@
} );
},
/**
- * @inheritdoc
* Remove the nearby menu entry if the browser doesn't support
geo location
*/
postRender: function () {
diff --git a/resources/skins.minerva.notifications.badge/NotificationBadge.js
b/resources/skins.minerva.notifications.badge/NotificationBadge.js
index 7f51830..f6a9e84 100644
--- a/resources/skins.minerva.notifications.badge/NotificationBadge.js
+++ b/resources/skins.minerva.notifications.badge/NotificationBadge.js
@@ -31,7 +31,6 @@
OO.mfExtend( NotificationBadge, View, {
/**
- * @inheritdoc
* @cfg {Object} defaults Default options hash.
* @cfg {String} defaults.notificationIconClass e.g. mw-ui-icon
for icon
* @cfg {String} defaults.loadingIconHtml for spinner
@@ -45,9 +44,6 @@
hasUnseenNotifications: false,
notificationCount: 0
},
- /**
- * @inheritdoc
- */
isBorderBox: false,
/**
* Loads a ResourceLoader module script. Shows ajax loader
whilst loading.
@@ -107,7 +103,6 @@
} );
} );
},
- /** @inheritdoc */
template: mw.template.get( 'skins.minerva.notifications.badge',
'badge.hogan' ),
/**
* Click handler for clicking on the badge
--
To view, visit https://gerrit.wikimedia.org/r/365046
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Idb3a6e9edbd45889047e7904561b84033569a689
Gerrit-PatchSet: 14
Gerrit-Project: mediawiki/skins/MinervaNeue
Gerrit-Branch: master
Gerrit-Owner: Jdlrobson <[email protected]>
Gerrit-Reviewer: Jdlrobson <[email protected]>
Gerrit-Reviewer: Krinkle <[email protected]>
Gerrit-Reviewer: Niedzielski <[email protected]>
Gerrit-Reviewer: Pmiazga <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
