MarkTraceur has uploaded a new change for review. https://gerrit.wikimedia.org/r/106848
Change subject: Adding first pass at jsduck docs ...................................................................... Adding first pass at jsduck docs Not many files enabled, but we'll add more soon. Change-Id: Id64da283c4bbeaae930103233f9e798b5a9db51b --- A docs/external.js A docs/generate A docs/jsduck-config.json M resources/ext.multimediaViewer/ext.multimediaViewer.lightboxinterface.js 4 files changed, 41 insertions(+), 0 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MultimediaViewer refs/changes/48/106848/1 diff --git a/docs/external.js b/docs/external.js new file mode 100644 index 0000000..e670c92 --- /dev/null +++ b/docs/external.js @@ -0,0 +1,19 @@ +/** + * @class mw + * @singleton + * <https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw> + */ + +/** + * @class mw.Title + * <https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.Title> + */ + +/** + * @class mlb + * @singleton + */ + +/** + * @class mlb.LightboxInterface + */ diff --git a/docs/generate b/docs/generate new file mode 100755 index 0000000..d27dfeb --- /dev/null +++ b/docs/generate @@ -0,0 +1,5 @@ +#!/usr/bin/env bash + +jsduck \ +--config=$(pwd)/docs/jsduck-config.json \ +&& echo 'JSDuck execution finished.' diff --git a/docs/jsduck-config.json b/docs/jsduck-config.json new file mode 100644 index 0000000..25431a7 --- /dev/null +++ b/docs/jsduck-config.json @@ -0,0 +1,12 @@ +{ + "--title": "MultimediaViewer extension documentation", + "--footer": "Documentation for MultimediaViewer, an extension to MediaWiki. Generated on {DATE} by {JSDUCK} {VERSION}.", + "--warnings": ["-no_doc"], + "--builtin-classes": true, + "--output": "./js", + "--": [ + "./external.js", + "../resources/ext.multimediaViewer/ext.multimediaViewer.lightboxinterface.js", + "../resources/ext.multimediaViewer/ext.multimediaViewer.lightboximage.js" + ] +} diff --git a/resources/ext.multimediaViewer/ext.multimediaViewer.lightboxinterface.js b/resources/ext.multimediaViewer/ext.multimediaViewer.lightboxinterface.js index d0d3bcd..41d85ab 100644 --- a/resources/ext.multimediaViewer/ext.multimediaViewer.lightboxinterface.js +++ b/resources/ext.multimediaViewer/ext.multimediaViewer.lightboxinterface.js @@ -18,6 +18,11 @@ ( function ( mw, $, oo, MLBInterface ) { var LIP; + /** + * @class mw.LightboxInterface + * @extends mlb.LightboxInterface + * @constructor + */ function LightboxInterface() { MLBInterface.call( this ); -- To view, visit https://gerrit.wikimedia.org/r/106848 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Id64da283c4bbeaae930103233f9e798b5a9db51b Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/MultimediaViewer Gerrit-Branch: master Gerrit-Owner: MarkTraceur <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
