Bug 474538 - nsIBrowserHistory::removePagesFromHost documentation is crazy, r=sdwilsh a=comment-only
authorGavin Sharp <gavin.sharp@gmail.com>
Sat, 28 Feb 2009 11:59:47 +0100
changeset 23595 fc5fe8d3d743320f598287cd2b8a223ea9bc16bb
parent 23594 53bc33d54b142b08ceb8fc97895703096942e97e
child 23596 69549aec001c3de131785a3b0f76eb30587026e9
push id814
push usermak77@bonardo.net
push dateSat, 28 Feb 2009 11:03:08 +0000
reviewerssdwilsh, comment-only
bugs474538
milestone1.9.1b3pre
Bug 474538 - nsIBrowserHistory::removePagesFromHost documentation is crazy, r=sdwilsh a=comment-only
toolkit/components/places/public/nsIBrowserHistory.idl
--- a/toolkit/components/places/public/nsIBrowserHistory.idl
+++ b/toolkit/components/places/public/nsIBrowserHistory.idl
@@ -83,21 +83,26 @@ interface nsIBrowserHistory : nsIGlobalH
      * instead setting aDoBatchNotify true will send Begin/EndUpdateBatch
      */
     void removePages([array, size_is(aLength)] in nsIURI aURIs,
                      in unsigned long aLength, in boolean aDoBatchNotify);
 
     /**
      * removePagesFromHost
      *
-     * Remove all pages from the given host.
-     * If aEntireDomain is true, will assume aHost is a domain,
-     * and remove all pages from the entire domain.
-     * Notice that this does not call observers for single deleted uris,
-     * instead it will send Begin/EndUpdateBatch
+     * Removes all history information about pages from a given host. If
+     * aEntireDomain is set, we will also delete pages from sub hosts (so if
+     * we are passed in "microsoft.com" we delete "www.microsoft.com",
+     * "msdn.microsoft.com", etc.). An empty host name means local files and
+     * anything else with no host name. You can also pass in the localized
+     * "(local files)" title given to you from a history query to remove all
+     * history information from local files.
+     *
+     * Note that this does not call observers for single deleted uris,
+     * but will send Begin/EndUpdateBatch.
      */
     void removePagesFromHost(in AUTF8String aHost, in boolean aEntireDomain);
 
     /**
      * removePagesByTimeframe
      *
      * Remove all pages for a given timeframe.
      * Limits are included: aBeginTime <= timeframe <= aEndTime