Bug 1397403 - Fix TabChild::GetActiveTabs comment (r=froydnj)
authorBill McCloskey <billm@mozilla.com>
Wed, 06 Sep 2017 12:01:16 -0700
changeset 429140 446245826a3e0f65da037a64f21d64f9f5979720
parent 429139 9967ddf61c89b809b0c819019e37ccaeb637ae34
child 429141 bfea6090979c54bea1d4b7ef56a8fa8f641da39a
push id7761
push userjlund@mozilla.com
push dateFri, 15 Sep 2017 00:19:52 +0000
treeherdermozilla-beta@c38455951db4 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersfroydnj
bugs1397403
milestone57.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 1397403 - Fix TabChild::GetActiveTabs comment (r=froydnj) MozReview-Commit-ID: LKb8U29M7DR
dom/ipc/TabChild.h
--- a/dom/ipc/TabChild.h
+++ b/dom/ipc/TabChild.h
@@ -752,20 +752,21 @@ public:
 
   void MaybeDispatchCoalescedMouseMoveEvents();
 
   static bool HasActiveTabs()
   {
     return sActiveTabs && !sActiveTabs->IsEmpty();
   }
 
-  // Returns whichever TabChild is currently in the foreground. If there are
-  // multiple TabChilds in the foreground (due to multiple windows being open),
-  // this returns null. This should only be called if HasActiveTabs() returns
-  // true.
+  // Returns the set of TabChilds that are currently in the foreground. There
+  // can be multiple foreground TabChilds if Firefox has multiple windows
+  // open. There can also be zero foreground TabChilds if the foreground tab is
+  // in a different content process. Note that this function should only be
+  // called if HasActiveTabs() returns true.
   static const nsTArray<TabChild*>& GetActiveTabs()
   {
     MOZ_ASSERT(HasActiveTabs());
     return *sActiveTabs;
   }
 
 protected:
   virtual ~TabChild();