Bug 1430691. Add a documenting comment to the nsIDocShell interface. r=nika

Differential Revision: https://phabricator.services.mozilla.com/D31356
This commit is contained in:
Jonathan Watt 2023-12-06 19:18:13 +00:00
parent 8f59b1fd25
commit da74a43f47

View file

@ -70,6 +70,21 @@ webidl ContentFrameMessageManager;
webidl EventTarget;
webidl Document;
/**
* nsIDocShell is an interface corresponding to the native nsDocShell object,
* which is a legacy in-process object roughly corresponding to a 'browsing
* context', as created for a browser tab or an iframe, for example.
*
* nsIDocShell has a 1:1 relationship with its paired dom::BrowsingContext and
* nsGlobalWindowOuter. It may be replaced during navigation.
*
* See also the comment documenting dom::BrowsingContext and the documentation
* at:
*
* https://html.spec.whatwg.org/multipage/document-sequences.html#browsing-context
* https://firefox-source-docs.mozilla.org/dom/navigation/embedding.html
* https://firefox-source-docs.mozilla.org/dom/navigation/nav_replace.html
*/
[scriptable, builtinclass, uuid(049234fe-da10-478b-bc5d-bc6f9a1ba63d)]
interface nsIDocShell : nsIDocShellTreeItem
{