Closed Bug 1014944 Opened 10 years ago Closed 10 years ago

nsIJSInspector's documentation is confusing

Categories

(DevTools :: Debugger, defect)

defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED
Firefox 32

People

(Reporter: jimb, Assigned: jimb)

Details

Attachments

(1 file)

Before I had gotten used to Gecko event loops, the comments and function names in nsIJSInspector.idl were confusing to me. Specifically

- enterNestedEventLoop not only enters, but also runs and exits an event loop.

- exitNestedEventLoop causes an event loop to exit once it has finished processing its current event, not immediately.

This patch tries to improve the docs, and spell out some more details.
Attachment #8427379 - Flags: review?(dcamp)
Comment on attachment 8427379 [details] [diff] [review]
Clarify documentation for nsIJSInspector.

Review of attachment 8427379 [details] [diff] [review]:
-----------------------------------------------------------------

Should we just rename the method?

Up to you, r+ if you don't want to hold up on that.
Attachment #8427379 - Flags: review?(dcamp) → review+
I think a rename would be good, but just landing the docs is a step forward, so:

https://hg.mozilla.org/integration/mozilla-inbound/rev/847fabdcca45
Flags: in-testsuite-
Target Milestone: --- → Firefox 32
https://hg.mozilla.org/mozilla-central/rev/847fabdcca45
Assignee: nobody → jimb
Status: NEW → RESOLVED
Closed: 10 years ago
Resolution: --- → FIXED
Product: Firefox → DevTools
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: