Bug 802366 - Prelude, part 5: Improve comments in nsIDocShellTreeItem.idl and nsILoadContext.idl. r=bz

This commit is contained in:
Justin Lebar 2012-11-10 10:32:36 -08:00
parent b5f6c6b1b5
commit 9633a49ba0
2 changed files with 6 additions and 5 deletions

View File

@ -53,10 +53,11 @@ interface nsIDocShellTreeItem : nsIDocShellTreeNode
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;

View File

@ -83,7 +83,7 @@ interface nsILoadContext : nsISupports
[noscript] void SetPrivateBrowsing(in boolean aInPrivateBrowsing);
/**
* 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;