From 121d42b7568af805b589044a8e088f7c5093f721 Mon Sep 17 00:00:00 2001 From: Mirko Brodesser Date: Thu, 23 Sep 2021 13:14:01 +0000 Subject: [PATCH] Bug 1731264: update documentation about PopupNotifications in PermissionsUI.jsm. r=pbz DONTBUILD Differential Revision: https://phabricator.services.mozilla.com/D126081 --- browser/modules/PermissionUI.jsm | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/browser/modules/PermissionUI.jsm b/browser/modules/PermissionUI.jsm index f2a95d8afc86..e7df6ef09a18 100644 --- a/browser/modules/PermissionUI.jsm +++ b/browser/modules/PermissionUI.jsm @@ -166,9 +166,9 @@ var PermissionPromptPrototype = { }, /** - * These are the options that will be passed to the - * PopupNotification when it is shown. See the documentation - * for PopupNotification for more details. + * These are the options that will be passed to the PopupNotification when it + * is shown. See the documentation of `PopupNotifications_show` in + * PopupNotifications.jsm for details. * * Note that prompt() will automatically set displayURI to * be the URI of the requesting pricipal, unless the displayURI is exactly @@ -209,7 +209,7 @@ var PermissionPromptPrototype = { * then you need to make sure its ID has the "-notification" suffix, * and then return the prefix here. * - * See PopupNotification.jsm for more details. + * See PopupNotifications.jsm for more details. * * @return {string} * The unique ID that will be used to as the @@ -230,9 +230,8 @@ var PermissionPromptPrototype = { }, /** - * The message to show to the user in the PopupNotification. A string - * with "<>" as a placeholder that is usually replaced by an addon name - * or a host name, formatted in bold, to describe the permission that is being requested. + * The message to show to the user in the PopupNotification, see + * `PopupNotifications_show` in PopupNotifications.jsm. * * Subclasses must override this. * -- 2.11.4.GIT