Bug 802366 - Prelude, part 5: Improve comments in nsIDocShellTreeItem.idl and nsILoadContext.idl. r=bz, a=blocking-basecamp
authorJustin Lebar <justin.lebar@gmail.com>
Sat, 10 Nov 2012 10:32:36 -0800
changeset 114120 684f0b8beb12559162f932447ccef0945fa40687
parent 114119 dc3a2243fef9c5b2bf88948ce88f9aa145813130
child 114121 20ded27ba11412ccba2fb91446379fc655285dcf
push id2647
push userryanvm@gmail.com
push dateSat, 10 Nov 2012 22:23:29 +0000
treeherdermozilla-aurora@ca854140dd54 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersbz, blocking-basecamp
bugs802366
milestone18.0a2
Bug 802366 - Prelude, part 5: Improve comments in nsIDocShellTreeItem.idl and nsILoadContext.idl. r=bz, a=blocking-basecamp
docshell/base/nsIDocShellTreeItem.idl
docshell/base/nsILoadContext.idl
--- a/docshell/base/nsIDocShellTreeItem.idl
+++ b/docshell/base/nsIDocShellTreeItem.idl
@@ -48,20 +48,21 @@ interface nsIDocShellTreeItem : nsIDocSh
 	attribute long itemType;
 
 	/*
 	Parent DocShell.
 	*/
 	readonly attribute nsIDocShellTreeItem parent;
 
 	/*
-	This is call returns the same thing parent does however if the parent is
-	of a different itemType, it will instead return nullptr.  This call is a
-	convience function for those wishing to not cross the boundaries at which
-	item types change.
+	This getter returns the same thing parent does however if the parent
+	is of a different itemType, or if the parent is an <iframe mozbrowser>
+	or <iframe mozapp>, it will instead return nullptr.  This call is a
+	convience function for those wishing to not cross the boundaries at
+	which item types change.
 	*/
 	readonly attribute nsIDocShellTreeItem sameTypeParent;
 
 	/*
 	Returns the root DocShellTreeItem.  This is a convience equivalent to 
 	getting the parent and its parent until there isn't a parent.
 	*/
 	readonly attribute nsIDocShellTreeItem rootTreeItem;
--- a/docshell/base/nsILoadContext.idl
+++ b/docshell/base/nsILoadContext.idl
@@ -73,17 +73,17 @@ interface nsILoadContext : nsISupports
   bool UsePrivateBrowsing() {
     bool usingPB;
     GetUsePrivateBrowsing(&usingPB);
     return usingPB;
   }
 %}
 
   /**
-   * Returns true iif the load is occurring inside a browser element.
+   * Returns true iff the load is occurring inside a browser element.
    */
   readonly attribute boolean isInBrowserElement;
 
   /**
    * Returns the app id of the app the load is occurring is in. Returns
    * nsIScriptSecurityManager::NO_APP_ID if the load is not part of an app.
    */
   readonly attribute unsigned long appId;