Bug 1233086, Part 4 - Gecko style fixes. r=seth
authorKit Cambridge <kcambridge@mozilla.com>
Fri, 04 Mar 2016 10:20:26 -0800
changeset 342815 a21989d264ee66319e274891a12c390482dd9345
parent 342814 14e487fc2bad07b1d1da91fa31e6b8e5955a2bbd
child 342816 87c50f8365f82badd5f04ea7a223a52ce6278852
push id6389
push userraliiev@mozilla.com
push dateMon, 19 Sep 2016 13:38:22 +0000
treeherdermozilla-beta@01d67bfe6c81 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersseth
bugs1233086
milestone50.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 1233086, Part 4 - Gecko style fixes. r=seth MozReview-Commit-ID: 8QtO5TDODFD
toolkit/components/alerts/nsIAlertsService.idl
--- a/toolkit/components/alerts/nsIAlertsService.idl
+++ b/toolkit/components/alerts/nsIAlertsService.idl
@@ -16,45 +16,45 @@ interface nsIURI;
 %}
 
 [scriptable, uuid(a71a637d-de1d-47c6-a8d2-c60b2596f471)]
 interface nsIAlertNotificationImageListener : nsISupports
 {
   /**
    * Called when the image finishes loading.
    *
-   * @param userData An opaque parameter passed to |loadImage|.
-   * @param request  The image request.
+   * @param aUserData An opaque parameter passed to |loadImage|.
+   * @param aRequest  The image request.
    */
-  void onImageReady(in nsISupports userData, in imgIRequest request);
+  void onImageReady(in nsISupports aUserData, in imgIRequest aRequest);
 
   /**
    * Called if the alert doesn't have an image, or if the image request times
    * out or fails.
    *
-   * @param userData An opaque parameter passed to |loadImage|.
+   * @param aUserData An opaque parameter passed to |loadImage|.
    */
-  void onImageMissing(in nsISupports userData);
+  void onImageMissing(in nsISupports aUserData);
 };
 
 [scriptable, uuid(cf2e4cb6-4b8f-4eca-aea9-d51a8f9f7a50)]
 interface nsIAlertNotification : nsISupports
 {
   /** Initializes an alert notification. */
-  void init([optional] in AString name,
-            [optional] in AString imageURL,
-            [optional] in AString title,
-            [optional] in AString text,
-            [optional] in boolean textClickable,
-            [optional] in AString cookie,
-            [optional] in AString dir,
-            [optional] in AString lang,
-            [optional] in AString data,
-            [optional] in nsIPrincipal principal,
-            [optional] in boolean inPrivateBrowsing);
+  void init([optional] in AString aName,
+            [optional] in AString aImageURL,
+            [optional] in AString aTitle,
+            [optional] in AString aText,
+            [optional] in boolean aTextClickable,
+            [optional] in AString aCookie,
+            [optional] in AString aDir,
+            [optional] in AString aLang,
+            [optional] in AString aData,
+            [optional] in nsIPrincipal aPrincipal,
+            [optional] in boolean aInPrivateBrowsing);
 
   /**
    * The name of the notification. On Android, the name is hashed and used as
    * a notification ID. Notifications will replace previous notifications with
    * the same name.
    */
   readonly attribute AString name;
 
@@ -131,43 +131,43 @@ interface nsIAlertNotification : nsISupp
    * The host and port of the originating page, or an empty string if the alert
    * is not actionable.
    */
   readonly attribute AString source;
 
   /**
    * Loads the image associated with this alert.
    *
-   * @param timeout  The number of milliseconds to wait before cancelling the
-   *                 image request. If zero, there is no timeout.
-   * @param listener An |nsIAlertNotificationImageListener| implementation,
-   *                 notified when the image loads. The listener is kept alive
-   *                 until the request completes.
-   * @param userData An opaque parameter passed to the listener's methods.
-   *                 Not used by the libnotify backend, but the OS X backend
-   *                 passes the pending notification.
+   * @param aTimeout  The number of milliseconds to wait before cancelling the
+   *                  image request. If zero, there is no timeout.
+   * @param aListener An |nsIAlertNotificationImageListener| implementation,
+   *                  notified when the image loads. The listener is kept alive
+   *                  until the request completes.
+   * @param aUserData An opaque parameter passed to the listener's methods.
+   *                  Not used by the libnotify backend, but the OS X backend
+   *                  passes the pending notification.
    */
-  nsICancelable loadImage(in unsigned long timeout,
-                          in nsIAlertNotificationImageListener listener,
-                          [optional] in nsISupports userData);
+  nsICancelable loadImage(in unsigned long aTimeout,
+                          in nsIAlertNotificationImageListener aListener,
+                          [optional] in nsISupports aUserData);
 };
 
 [scriptable, uuid(f7a36392-d98b-4141-a7d7-4e46642684e3)]
 interface nsIAlertsService : nsISupports
 {
-  void showPersistentNotification(in AString persistentData,
-                                  in nsIAlertNotification alert,
-                                  [optional] in nsIObserver alertListener);
+  void showPersistentNotification(in AString aPersistentData,
+                                  in nsIAlertNotification aAlert,
+                                  [optional] in nsIObserver aAlertListener);
 
-  void showAlert(in nsIAlertNotification alert,
-                 [optional] in nsIObserver alertListener);
+  void showAlert(in nsIAlertNotification aAlert,
+                 [optional] in nsIObserver aAlertListener);
   /**
    * Initializes and shows an |nsIAlertNotification| with the given parameters.
    *
-   * @param alertListener  Used for callbacks. May be null if the caller
+   * @param aAlertListener Used for callbacks. May be null if the caller
    *                       doesn't care about callbacks.
    * @see nsIAlertNotification for descriptions of all other parameters.
    * @throws NS_ERROR_NOT_AVAILABLE If the notification cannot be displayed.
    *
    * The following arguments will be passed to the alertListener's observe()
    * method:
    *   subject - null
    *   topic   - "alertfinished" when the alert goes away
@@ -177,38 +177,38 @@ interface nsIAlertsService : nsISupports
    *             "alertshow" when the alert is shown
    *   data    - the value of the cookie parameter passed to showAlertNotification.
    *
    * @note Depending on current circumstances (if the user's in a fullscreen
    *       application, for instance), the alert might not be displayed at all.
    *       In that case, if an alert listener is passed in it will receive the
    *       "alertfinished" notification immediately.
    */
-  void showAlertNotification(in AString  imageUrl,
-                             in AString  title,
-                             in AString  text,
-                             [optional] in boolean textClickable,
-                             [optional] in AString cookie,
-                             [optional] in nsIObserver alertListener,
-                             [optional] in AString name,
-                             [optional] in AString dir,
-                             [optional] in AString lang,
-                             [optional] in AString data,
-                             [optional] in nsIPrincipal principal,
-                             [optional] in boolean inPrivateBrowsing);
+  void showAlertNotification(in AString aImageURL,
+                             in AString aTitle,
+                             in AString aText,
+                             [optional] in boolean aTextClickable,
+                             [optional] in AString aCookie,
+                             [optional] in nsIObserver aAlertListener,
+                             [optional] in AString aName,
+                             [optional] in AString aDir,
+                             [optional] in AString aLang,
+                             [optional] in AString aData,
+                             [optional] in nsIPrincipal aPrincipal,
+                             [optional] in boolean aInPrivateBrowsing);
 
   /**
    * Close alerts created by the service.
    *
-   * @param name           The name of the notification to close. If no name
+   * @param aName          The name of the notification to close. If no name
    *                       is provided then only a notification created with
    *                       no name (if any) will be closed.
    */
-  void closeAlert([optional] in AString name,
-                  [optional] in nsIPrincipal principal);
+  void closeAlert([optional] in AString aName,
+                  [optional] in nsIPrincipal aPrincipal);
 
 };
 
 [scriptable, uuid(c5d63e3a-259d-45a8-b964-8377967cb4d2)]
 interface nsIAlertsDoNotDisturb : nsISupports
 {
   /**
    * Toggles a manual Do Not Disturb mode for the service to reduce the amount
@@ -224,58 +224,58 @@ interface nsIAlertsDoNotDisturb : nsISup
 
 [scriptable, uuid(df1bd4b0-3a8c-40e6-806a-203f38b0bd9f)]
 interface nsIAlertsProgressListener : nsISupports
 {
   /**
    * Called to notify the alert service that progress has occurred for the
    * given notification previously displayed with showAlertNotification().
    *
-   * @param name         The name of the notification displaying the
+   * @param aName        The name of the notification displaying the
    *                     progress. On Android the name is hashed and used
    *                     as a notification ID.
-   * @param progress     Numeric value in the range 0 to progressMax
+   * @param aProgress    Numeric value in the range 0 to progressMax
    *                     indicating the current progress.
-   * @param progressMax  Numeric value indicating the maximum progress.
-   * @param text         The contents of the alert. If not provided,
+   * @param aProgressMax Numeric value indicating the maximum progress.
+   * @param aText        The contents of the alert. If not provided,
    *                     the percentage will be displayed.
    */
-  void onProgress(in AString name,
-                  in long long progress,
-                  in long long progressMax,
-                  [optional] in AString text);
+  void onProgress(in AString aName,
+                  in long long aProgress,
+                  in long long aProgressMax,
+                  [optional] in AString aText);
 
   /**
    * Called to cancel and hide the given notification previously displayed
    * with showAlertNotification().
    *
-   * @param name         The name of the notification.
+   * @param aName        The name of the notification.
    */
-  void onCancel(in AString name);
+  void onCancel(in AString aName);
 };
 
 [scriptable, uuid(fc6d7f0a-0cf6-4268-8c71-ab640842b9b1)]
 interface nsIAlertsIconData : nsISupports
 {
   /**
    * Shows an alert with an icon. Web notifications use the favicon of the
    * page that created the alert. If the favicon is not in the Places database,
-   * |iconSize| will be zero.
+   * |aIconSize| will be zero.
   */
-  void showAlertWithIconData(in nsIAlertNotification alert,
-                             [optional] in nsIObserver alertListener,
-                             [optional] in uint32_t iconSize,
-                             [const, array, size_is(iconSize)] in uint8_t
-                                                               iconData);
+  void showAlertWithIconData(in nsIAlertNotification aAlert,
+                             [optional] in nsIObserver aAlertListener,
+                             [optional] in uint32_t aIconSize,
+                             [const, array, size_is(aIconSize)] in uint8_t
+                                                                aIconData);
 };
 
 [scriptable, uuid(f3c82915-bf60-41ea-91ce-6c46b22e381a)]
 interface nsIAlertsIconURI : nsISupports
 {
   /**
    * Shows an alert with an icon URI. Web notifications use |moz-anno:|
    * URIs to reference favicons from Places. If the page doesn't have a
-   * favicon, |iconURI| will be |null|.
+   * favicon, |aIconURI| will be |null|.
    */
-  void showAlertWithIconURI(in nsIAlertNotification alert,
-                            [optional] in nsIObserver alertListener,
-                            [optional] in nsIURI iconURI);
+  void showAlertWithIconURI(in nsIAlertNotification aAlert,
+                            [optional] in nsIObserver aAlertListener,
+                            [optional] in nsIURI aIconURI);
 };