Bug 1731994: part 3) Extend documentation of `ContentPermissionRequestBase`'s constructor. r=edgar
authorMirko Brodesser <mbrodesser@mozilla.com>
Thu, 23 Sep 2021 08:48:17 +0000
changeset 593037 a4d5bf7a3369b0df728c2211eee1d56ee1e10c85
parent 593036 5dece26f14db8ee184ce88f0fd0df645d0be8640
child 593038 d8ff1ee1494904be8f2d47460bcb8375551f3943
push id150253
push usermbrodesser@mozilla.com
push dateThu, 23 Sep 2021 08:50:50 +0000
treeherderautoland@d8ff1ee14949 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersedgar
bugs1731994
milestone94.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1731994: part 3) Extend documentation of `ContentPermissionRequestBase`'s constructor. r=edgar Differential Revision: https://phabricator.services.mozilla.com/D126349
dom/base/nsContentPermissionHelper.h
--- a/dom/base/nsContentPermissionHelper.h
+++ b/dom/base/nsContentPermissionHelper.h
@@ -132,16 +132,17 @@ class ContentPermissionRequestBase : pub
     Allow,
     Deny,
     Request,
   };
   void RequestDelayedTask(nsIEventTarget* aTarget, DelayedTaskType aType);
 
  protected:
   // @param aPrefName see `mPrefName`.
+  // @param aType see `mType`.
   ContentPermissionRequestBase(nsIPrincipal* aPrincipal,
                                nsPIDOMWindowInner* aWindow,
                                const nsACString& aPrefName,
                                const nsACString& aType);
   virtual ~ContentPermissionRequestBase() = default;
 
   nsCOMPtr<nsIPrincipal> mPrincipal;
   nsCOMPtr<nsIPrincipal> mTopLevelPrincipal;
@@ -150,17 +151,20 @@ class ContentPermissionRequestBase : pub
 
   // The prefix of a pref which allows tests to bypass showing the prompt.
   // Tests will have to set both of
   // ${mPrefName}.prompt.testing and
   // ${mPrefName}.prompt.testing.allow
   // to either true or false. If no such testing is required, mPrefName may be
   // empty.
   const nsCString mPrefName;
+
+  // The type of the request, such as "autoplay-media-audible".
   const nsCString mType;
+
   bool mIsHandlingUserInput;
   bool mMaybeUnsafePermissionDelegate;
 };
 
 }  // namespace dom
 }  // namespace mozilla
 
 using mozilla::dom::ContentPermissionRequestParent;