91703 - vague comment about consume/ignore return values for listeners

Status: NEW

(Core :: DOM: UI Events & Focus Handling, defect)

Description

[Jesse Ruderman]

Several comments say "returns whether the event was consumed or ignored".  
These comments should be more specific: what should implementers return to 
consume the event?  What should they return to ignore it?

(Also, a nearby comment mentions the non-existent nsIDOMEvent.h.)

Several of the files with the confusing comment:
- dom/public/coreEvents/nsIDOMFocusListener.h
- dom/public/coreEvents/nsIDOMMouseListener.h
- dom/public/coreEvents/nsIDOMKeyListener.h

Here's what the comment looks like:

/**
 * Processes a mouse down event
 * @param aMouseEvent @see nsIDOMEvent.h
 * @returns whether the event was consumed or ignored. @see nsresult
 */
NS_IMETHOD MouseDown(nsIDOMEvent* aMouseEvent) = 0;

Comment 1

[Pham]

.

Comment 2

[Vedran Miletic]

retargeting