Bug 1220607 - Expand on the nsILoadGroup interface's comment to indicate how it is used. r=bz IGNORE IDL
authorJonathan Watt <jwatt@jwatt.org>
Tue, 29 Sep 2015 15:49:15 +0100
changeset 270864 ffe32a4ed0a0b21d021fbdd2df1abb17e8d50f66
parent 270863 6d65e95193c98311e6f4a33c1c7a27eb4f0f766c
child 270865 78cbe4c1c2a1fd0703bd2e8c5a3fcf1e35e7bb71
push id29626
push usercbook@mozilla.com
push dateTue, 03 Nov 2015 11:00:46 +0000
treeherdermozilla-central@bb4d614a0b09 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersbz
bugs1220607
milestone45.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 1220607 - Expand on the nsILoadGroup interface's comment to indicate how it is used. r=bz IGNORE IDL
netwerk/base/nsILoadGroup.idl
--- a/netwerk/base/nsILoadGroup.idl
+++ b/netwerk/base/nsILoadGroup.idl
@@ -8,17 +8,21 @@
 interface nsISimpleEnumerator;
 interface nsIRequestObserver;
 interface nsIInterfaceRequestor;
 interface nsISchedulingContext;
 
 typedef unsigned long nsLoadFlags;
 
 /**
- * A load group maintains a collection of nsIRequest objects. 
+ * A load group maintains a collection of nsIRequest objects.
+ * This is used in lots of places where groups of requests need to be tracked.
+ * For example, nsIDocument::mDocumentLoadGroup is used to track all requests
+ * made for subdocuments in order to track page load progress and allow all
+ * requests made on behalf of the document to be stopped, etc.
  */
 [scriptable, uuid(f0c87725-7a35-463c-9ceb-2c07f23406cc)]
 interface nsILoadGroup : nsIRequest
 {
     /**
      * The group observer is notified when requests are added to and removed
      * from this load group.  The groupObserver is weak referenced.
      */