Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-10-14 22:05:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarified some documentation.

Browse Source
This commit is contained in:
tbogard%aol.net 1999-09-08 19:24:16 +00:00
parent b4e0d76200
commit a4d2794e61
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
xpcom/appshell/eventloop/xp/nsIEventLoop.idl
View File

@ -147,7 +147,7 @@ interface nsIEventLoop : nsISupports
event object that can store the event data. You can get one of
these by calling CreateEvent().
@return NS_OK - evt has been retrieved and ready to be processed.
NS_COMFALSE - An exit event has been signalled. evt may be null.
NS_COMFALSE - An exit event has been signalled.
NS_ERROR_INVALID_ARG - The event passed in was invalid.
NS_ERROR_FAILURE - Internal failure, ignore all results and
cease use of loop.
@ -171,9 +171,12 @@ interface nsIEventLoop : nsISupports
@param fRemoveEvent Indicates that the Event should be removed from the
queue as it is pulled off. Passing false allows you to walk
through the queue without actually removing the queued messages.
Be careful when you do this.
Be careful when you do this. (False is not supported in all
implementations, in those that do not support false, NS_COMFALSE
will be returned.)
@return NS_OK - msg has been retrieved and ready to be processed.
NS_COMFALSE - There are no more events to retrieve. evt will be null.
NS_COMFALSE - There are no more events to retrieve. Or
fRemoveEvent was false and this is not supported.
NS_ERROR_INVALID_ARG - The event passed in was invalid.
NS_ERROR_FAILURE - Internal failure, ignore all results and
cease use of loop.