267034 - Improve nsIAlertsService documentation

Status: RESOLVED FIXED

(Core :: XUL, enhancement)

Description

[Christian :Biesinger (don't email me, ping me on IRC)]

from bug 260865 comment 2:
<biesi> 1. can the listener be null
<biesi> 2. can I put up an alert when a previous one is up
<biesi> 3. what happens if I try 2

comments should use doxygen-style

Comment 1

[Mike Connor [:mconnor]]

Since toolkit has the same issue, it'd be nice to have the patch for this cover
both.

Comment 2

[Nickolay_Ponomarev]

Attachment: patch

Makes the comments doxygen-style, gives a bit more information. (The XPFE version is almost the same, I'll make a patch for it after this one gets reviewed.)

Current alerts implementation doesn't deal very well with the situation of two simultaneous notifications - it displays two (overlapping) alerts, - but I think that we should fix instead of documenting it.

Comment 3

[Nickolay_Ponomarev]

BTW, is it a good idea to link to MDC documentation from the IDL?
http://developer.mozilla.org/en/docs/nsIAlertsService

Comment 4

[Nickolay_Ponomarev]

Attachment: patch for checkin

now with the same changes for XPFE

Comment 5

[:Gavin Sharp [email: [e-mail]]]

mozilla/xpfe/components/alerts/public/nsIAlertsService.idl;    new revision: 1.7;
mozilla/toolkit/components/alerts/public/nsIAlertsService.idl; new revision: 1.6;