Bug 953311 - nsIdleService.idl and .cpp comments are still suggesting a "back" notification. r=gsvelto
authorMarco Bonardo <mbonardo@mozilla.com>
Wed, 08 Jan 2014 18:43:03 +0100
changeset 162555 d19f386b906122cb8a3f1dbd4c74825c5d07f84b
parent 162554 140736b7365514c4c4e4fbaf52bc242ddbcc4a57
child 162556 f23f0b5c59a54716f1b2668126e568fe404d5a3e
push id38236
push usermak77@bonardo.net
push dateWed, 08 Jan 2014 17:43:33 +0000
treeherdermozilla-inbound@d19f386b9061 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersgsvelto
bugs953311
milestone29.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 953311 - nsIdleService.idl and .cpp comments are still suggesting a "back" notification. r=gsvelto
widget/nsIIdleService.idl
widget/xpwidgets/nsIdleService.cpp
--- a/widget/nsIIdleService.idl
+++ b/widget/nsIIdleService.idl
@@ -7,17 +7,17 @@
 #include "nsISupports.idl"
 interface nsIObserver;
 
 /**
  * This interface lets you monitor how long the user has been 'idle',
  * i.e. not used their mouse or keyboard. You can get the idle time directly,
  * but in most cases you will want to register an observer for a predefined
  * interval. The observer will get an 'idle' notification when the user is idle
- * for that interval (or longer), and receive a 'back' notification when the
+ * for that interval (or longer), and receive an 'active' notification when the
  * user starts using their computer again.
  */
 
 [scriptable, uuid(cc52f19a-63ae-4a1c-9cc3-e79eace0b471)]
 interface nsIIdleService : nsISupports
 {
     /**
      * The amount of time in milliseconds that has passed
@@ -35,18 +35,18 @@ interface nsIIdleService : nsISupports
      *
      * @param observer the observer to be notified
      * @param time the amount of time in seconds the user should be idle before
      *             the observer should be notified.
      *
      * @note
      * The subject of the notification the observer will get is always the
      * nsIIdleService itself.
-     * When the user goes idle, the observer topic is "idle" and when they get
-     * back, the observer topic is "back".
+     * When the user goes idle, the observer topic is "idle" and when he gets
+     * back, the observer topic is "active".
      * The data param for the notification contains the current user idle time.
      *
      * @note
      * You can add the same observer twice.
      * @note
      * Most implementations need to poll the OS for idle info themselves,
      * meaning your notifications could arrive with a delay up to the length
      * of the polling interval in that implementation.
--- a/widget/xpwidgets/nsIdleService.cpp
+++ b/widget/xpwidgets/nsIdleService.cpp
@@ -573,18 +573,18 @@ nsIdleService::ResetIdleTimeOut(uint32_t
   Telemetry::Accumulate(Telemetry::IDLE_NOTIFY_BACK_LISTENERS,
                         numberOfPendingNotifications);
 
   // Bail if nothing to do.
   if (!numberOfPendingNotifications) {
     return NS_OK;
   }
 
-  // Now send "back" events to all, if any should have timed out allready, then
-  // they will be reawaken by the timer that is already running.
+  // Now send "active" events to all, if any should have timed out already,
+  // then they will be reawaken by the timer that is already running.
 
   // We need a text string to send with any state change events.
   nsAutoString timeStr;
 
   timeStr.AppendInt((int32_t)(idleDeltaInMS / PR_MSEC_PER_SEC));
 
   // Send the "non-idle" events.
   while (numberOfPendingNotifications--) {