415941 - nsISessionStore documentation: clarify the meaning of "window"

Status: RESOLVED FIXED

(Firefox :: Session Restore, defect)

Description

[Simon Bünzli]

Comment 1

[Simon Bünzli]

Attachment: API documentation update

Comment 2

[Asaf Romano (gone)]

Comment on attachment 331856 [details] [diff] [review]
API documentation update

>diff -r 588493551f72 browser/components/sessionstore/nsISessionStore.idl
>--- a/browser/components/sessionstore/nsISessionStore.idl	Thu Jul 31 11:23:29 2008 -0700
>+++ b/browser/components/sessionstore/nsISessionStore.idl	Thu Jul 31 13:28:03 2008 -0700
>@@ -38,17 +38,31 @@
> #include "nsISupports.idl"
> 
> interface nsIDOMWindow;
> interface nsIDOMNode;
> 
> /**
>  * nsISessionStore keeps track of the current browsing state - i.e.
>  * tab history, cookies, scroll state, form data, POSTDATA and window features
>- * - and allows to restore everything into one window.
>+ * - and allows to restore everything into one browser window.
>+ *
>+ * The nsISessionStore API operates mostly on browser windows and the tabbrowser
>+ * tabs contained in them:
>+ *
>+ * * "Browser windows" are those DOM windows having loaded
>+ * chrome://browser/content/browser.xul . From overlays you can just pass the
>+ * global |window| object to the API, though. From elsewhere you can get browser

Suggest using top here in child windows (like the sidebar).

>+ * windows through the nsIWindowMediator by looking for "navigator:browser" windows.
>+ *
>+ * * "Tabbrowser tabs" are all the children of a browser window's
>+ * |getBrowser().tabContainer| such as e.g. |getBrowser().selectedTab|.
>+ *

s/children/child windows/ ?

>+ * Note: This API will break in all sorts of way if the preference
>+ *       browser.sessionstore.enabled is set to false.
>  */

File the follow up bug for the improvement we disscussed.


Please change "@return A" to "@returns a" while you're at it.

Comment 3

[Simon Bünzli]

Attachment: updated to comment #2

(In reply to comment #2)
> Suggest using top here in child windows (like the sidebar).

Fixed.

> s/children/child windows/ ?

s/children/child nodes/ -> fixed

> File the follow up bug for the improvement we disscussed.

Filed as bug 448725.

> Please change "@return A" to "@returns a" while you're at it.

Fixed.

Comment 4

[Dão Gottwald [:dao]]

http://hg.mozilla.org/index.cgi/mozilla-central/rev/75b6d8f09329