Phuedx has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/355474 )
Change subject: WIP doc: Document gateway modules
......................................................................
WIP doc: Document gateway modules
Additional changes:
* Fix the summary not showing up for the Container interface.
Bug: T158236
Change-Id: I7c5dee1b4525c2db28b89e57604d2d073620293d
---
M src/container.js
M src/gateway/index.js
2 files changed, 13 insertions(+), 10 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Popups
refs/changes/74/355474/1
diff --git a/src/container.js b/src/container.js
index 50ae86b..97e9c28 100644
--- a/src/container.js
+++ b/src/container.js
@@ -12,10 +12,9 @@
cache = {};
/**
- * @interface Container
- *
* The interface implemented by all service containers.
*
+ * @interface Container
* @global
*/
return {
diff --git a/src/gateway/index.js b/src/gateway/index.js
index e2c6285..318bb16 100644
--- a/src/gateway/index.js
+++ b/src/gateway/index.js
@@ -1,18 +1,22 @@
+// Note that this interface definition is in the global scope.
/**
- * Interface for API gateway that fetches page summary
+ * The interface implemented by all preview gateways.
*
- * @interface ext.popups.Gateway
+ * @interface Gateway
*/
/**
- * Returns a preview model fetched from the api
+ * Returns a preview fetched from some source.
+ *
+ * If the underlying request is successful and the response is not empty;
+ * otherwise it rejects.
+ *
* @function
- * @name ext.popups.Gateway#getPageSummary
- * @param {String} title Page title we're querying
- * @returns {jQuery.Promise} that resolves with {ext.popups.PreviewModel}
- * if the request is successful and the response is not empty; otherwise
- * it rejects.
+ * @name Gateway#getPageSummary
+ * @param {String} title The title of the page to fetch the preview from.
+ * @returns {jQuery.Promise<PreviewModel>}
*/
+
module.exports = {
createMediaWikiApiGateway: require( './mediawiki' ),
createRESTBaseGateway: require( './rest' )
--
To view, visit https://gerrit.wikimedia.org/r/355474
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I7c5dee1b4525c2db28b89e57604d2d073620293d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Popups
Gerrit-Branch: master
Gerrit-Owner: Phuedx <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
