Bug 802366 - Prelude, part 5: Improve comments in nsIDocShellTreeItem.idl and nsILoadContext.idl. r=bz
☠☠ backed out by 039573154dcf ☠ ☠
authorJustin Lebar <justin.lebar@gmail.com>
Tue, 30 Oct 2012 15:55:05 -0400
changeset 111933 8048f22347ebf691a363bc9ccfb9aef06d5c6d2c
parent 111932 37357ffceb05b6bfad93f1c150feceb4b02977c8
child 111934 a6a847452dbff26ab4dc366102e5af67522cc09e
push id93
push usernmatsakis@mozilla.com
push dateWed, 31 Oct 2012 21:26:57 +0000
reviewersbz
bugs802366
milestone19.0a1
Bug 802366 - Prelude, part 5: Improve comments in nsIDocShellTreeItem.idl and nsILoadContext.idl. r=bz
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;