Bug 1487296 - Fix nsIHistory.idl formatting. r=nika
authorNicholas Nethercote <nnethercote@mozilla.com>
Thu, 30 Aug 2018 11:08:59 +1000
changeset 489576 8a18c6a79fb95d0bcba8c4ec02c81ef63bcd112a
parent 489567 634b562ae2c3af1c07e12cca895796cc501f343d
child 489577 e2ac39e3e6b7d3960570e13f6d7866477393f6b1
push id9738
push useraciure@mozilla.com
push dateMon, 03 Sep 2018 16:13:51 +0000
treeherdermozilla-beta@f5841408a66c [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersnika
bugs1487296
milestone63.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 1487296 - Fix nsIHistory.idl formatting. r=nika Mostly: - Fix indenting. - Remove trailing whitespace. - Use `aFoo` arguments.
docshell/shistory/nsISHistory.idl
--- a/docshell/shistory/nsISHistory.idl
+++ b/docshell/shistory/nsISHistory.idl
@@ -1,9 +1,9 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 #include "nsISupports.idl"
 
 interface nsISHEntry;
 interface nsISHistoryListener;
@@ -27,113 +27,113 @@ interface nsISHistory: nsISupports
    * bfcache around the currently active SHEntry.
    *
    * We try to keep viewers for SHEntries between index - VIEWER_WINDOW and
    * index + VIEWER_WINDOW alive.
    */
   const long VIEWER_WINDOW = 3;
 
   /**
-   * A readonly property of the interface that returns 
+   * A readonly property of the interface that returns
    * the number of toplevel documents currently available
    * in session history.
    */
-   readonly attribute long count;
+  readonly attribute long count;
 
   /**
    * A readonly property of the interface that returns
    * the index of the current document in session history.
    */
-   readonly attribute long index;
+  readonly attribute long index;
 
   /**
    * A readonly property of the interface that returns
    * the index of the last document that started to load and
    * didn't finished yet. When document finishes the loading
    * value -1 is returned.
    */
-   readonly attribute long requestedIndex;
+  readonly attribute long requestedIndex;
 
   /**
    * A read/write property of the interface, used to Get/Set
-   * the maximum number of toplevel documents, session history 
-   * can hold for each instance. 
+   * the maximum number of toplevel documents, session history
+   * can hold for each instance.
    */
-   attribute long maxLength;
+  attribute long maxLength;
 
   /**
    * Called to obtain handle to the history entry at a
    * given index.
    *
    * @param index             The index value whose entry is requested.
    *                          The oldest entry is located at index == 0.
    * @param modifyIndex       A boolean flag that indicates if the current
-   *                          index of session history should be modified 
+   *                          index of session history should be modified
    *                          to the parameter index.
    *
-   * @return                  <code>NS_OK</code> history entry for 
+   * @return                  <code>NS_OK</code> history entry for
    *                          the index is obtained successfully.
    *                          <code>NS_ERROR_FAILURE</code> Error in obtaining
    *                          history entry for the given index.
    */
-   nsISHEntry getEntryAtIndex(in long index, in boolean modifyIndex);
+  nsISHEntry getEntryAtIndex(in long aIndex, in boolean aModifyIndex);
 
   /**
    * Called to purge older documents from history.
-   * Documents can be removed from session history for various 
-   * reasons. For example to  control memory usage of the browser, to 
+   * Documents can be removed from session history for various
+   * reasons. For example to  control memory usage of the browser, to
    * prevent users from loading documents from history, to erase evidence of
    * prior page loads etc...
    *
    * @param numEntries        The number of toplevel documents to be
    *                          purged from history. During purge operation,
-   *                          the latest documents are maintained and older 
+   *                          the latest documents are maintained and older
    *                          'numEntries' documents are removed from history.
-   * @throws                  <code>NS_SUCCESS_LOSS_OF_INSIGNIFICANT_DATA</code> Purge was vetod.
+   * @throws                  <code>NS_SUCCESS_LOSS_OF_INSIGNIFICANT_DATA</code>
+   *                          Purge was vetod.
    * @throws                  <code>NS_ERROR_FAILURE</code> numEntries is
    *                          invalid or out of bounds with the size of history.
-   *                          
    */
-   void PurgeHistory(in long numEntries);
+  void PurgeHistory(in long aNumEntries);
 
   /**
    * Called to register a listener for the session history component.
    * Listeners are notified when pages are loaded or purged from history.
-   * 
+   *
    * @param aListener         Listener object to be notified for all
    *                          page loads that initiate in session history.
    *
-   * @note                    A listener object must implement 
+   * @note                    A listener object must implement
    *                          nsISHistoryListener and nsSupportsWeakReference
    *
    * @see nsISHistoryListener
    * @see nsSupportsWeakReference
    */
-   void addSHistoryListener(in nsISHistoryListener aListener);
+  void addSHistoryListener(in nsISHistoryListener aListener);
 
   /**
    * Called to remove a listener for the session history component.
    * Listeners are notified when pages are loaded from history.
-   * 
-   * @param aListener         Listener object to be removed from 
+   *
+   * @param aListener         Listener object to be removed from
    *                          session history.
    *
-   * @note                    A listener object must implement 
+   * @note                    A listener object must implement
    *                          nsISHistoryListener and nsSupportsWeakReference
    * @see nsISHistoryListener
    * @see nsSupportsWeakReference
-   */ 
-   void removeSHistoryListener(in nsISHistoryListener aListener);
+   */
+  void removeSHistoryListener(in nsISHistoryListener aListener);
 
-   void reloadCurrentEntry();
+  void reloadCurrentEntry();
 
-   /**
+  /**
    * Called to obtain the index to a given history entry.
    *
    * @param aEntry            The entry to obtain the index of.
    *
    * @return                  <code>NS_OK</code> index for the history entry
    *                          is obtained successfully.
    *                          <code>NS_ERROR_FAILURE</code> Error in obtaining
    *                          index for the given history entry.
    */
-   long getIndexOfEntry(in nsISHEntry aEntry);
+  long getIndexOfEntry(in nsISHEntry aEntry);
 };