aboutsummaryrefslogtreecommitdiffstats
path: root/resources/src/mediawiki.authenticationPopup/AuthPopup.js
diff options
context:
space:
mode:
authorBartosz Dziewoński <dziewonski@fastmail.fm>2024-05-30 02:32:14 +0200
committerBartosz Dziewoński <dziewonski@fastmail.fm>2024-05-30 02:32:14 +0200
commitc085d90c9cf5d3b3da68b4857dd29d5c41a513ee (patch)
treec5e611138e7188403fe0c37c716fb91bb9abfc38 /resources/src/mediawiki.authenticationPopup/AuthPopup.js
parent129de6756f98557acfa7fa39ddcbe670cf8dceb6 (diff)
downloadmediawikicore-c085d90c9cf5d3b3da68b4857dd29d5c41a513ee.tar.gz
mediawikicore-c085d90c9cf5d3b3da68b4857dd29d5c41a513ee.zip
Add JSDoc for mediawiki.authenticationPopup module
Follow-up to b18e4b3517d605fbabe375bf42a6bff4625f5c18. Bug: T364939 Change-Id: Ifa3283227515ff2ad78008249ea0075dbc279873
Diffstat (limited to 'resources/src/mediawiki.authenticationPopup/AuthPopup.js')
-rw-r--r--resources/src/mediawiki.authenticationPopup/AuthPopup.js3
1 files changed, 3 insertions, 0 deletions
diff --git a/resources/src/mediawiki.authenticationPopup/AuthPopup.js b/resources/src/mediawiki.authenticationPopup/AuthPopup.js
index 0a95c12b5d70..7c7f4393c9d4 100644
--- a/resources/src/mediawiki.authenticationPopup/AuthPopup.js
+++ b/resources/src/mediawiki.authenticationPopup/AuthPopup.js
@@ -152,6 +152,9 @@ function isIos() {
* The page opened in the popup should communicate success using the authSuccess.js script. If it
* doesn't, we also check for a login success when the user interacts with the parent window.
*
+ * The constructor is not publicly accessible in MediaWiki. Use the instance exposed by the
+ * {@link module:mediawiki.authenticationPopup mediawiki.authenticationPopup} module.
+ *
* **This library is not stable yet (as of May 2024). We're still testing which of the
* methods work from the technical side, and which methods are understandable for users.
* Some methods or the whole library may be removed in the future.**