362803 - nsIWebBrowserSetup lies about its abilities

Status: RESOLVED FIXED

(Core Graveyard :: Embedding: APIs, defect)

Description

[Chris Lawson (gone)]

[12:29am] <bz> using nsIWebBrowserSetup would work
[12:30am] <bz> on an existing webbrowser
[12:30am] <cl> the IDL suggested otherwise
[12:30am] <cl> but I'll play around with it some more.
[12:30am] <bz> 43  * The nsIWebBrowserSetup interface allows certain properties of a new browser
[12:30am] <bz> 44  * object to set before the browser window is opened.
[12:30am] <bz> That part?
[12:30am] <cl> yes.
[12:30am] <bz> That's basically a lie.

We should fix the documentation in that file, at least, so it isn't totally misleading. :)

Comment 1

[Eric Shepherd [:sheppy]]

Taking this; I take it that in reality the webbrowser needs to already be set up before setting up the properties?

Comment 2

[Boris Zbarsky [:bzbarsky]]

No.  In reality, you can change the properties dynamically any time you want to.  The IDL claims that you can't, but that's false.

Comment 3

[Eric Shepherd [:sheppy]]

Ah-ha!  The quoted text in the IRC clipping here doesn't mention that part.  Got it.

Comment 4

[Eric Shepherd [:sheppy]]

Whoops, this is talking about updating docs in an IDL file, which isn't something I can do.

Comment 5

[Eric Shepherd [:sheppy]]

I guess I could submit a patch if someone else doesn't want to do it.

Comment 6

[Eric Shepherd [:sheppy]]

Attachment: change description

Here's a patch that rewords the description of nsIWebBrowserSetup.

Comment 7

[Boris Zbarsky [:bzbarsky]]

Comment on attachment 255140 [details] [diff] [review]
change description

Looks good to me...

Comment 8

[Boris Zbarsky [:bzbarsky]]

Checked in.  Eric, thanks for the fix!

Comment 9

[Eric Shepherd [:sheppy]]

Setting dev-doc-complete.