annotate doc/sound-signals.dox @ 15285:21509d8e4e70

[gaim-migrate @ 18075] It appears that bye_cmd() can be reached with an MsnCmdProc whose data is NULL -- that is, which was for a switchboard which has been destroyed. This may be better as a simple if (swboard == NULL) return; but since the code doesn't have a check for it at present I thought a g_return_if_fail() would be better until someone who understands all the MSN internals can take a closer look at what's going on. committer: Tailor Script <[e-mail]>

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 <hr>

 @signaldef playing-sound-event
  @signalproto
gboolean (*playing_sound_event)(GaimSoundEventID event, GaimAccount *account);
  @endsignalproto
  @signaldesc
   Emitted when gaim is going to play a sound event. This can be used to cancel playing sound by returning TRUE.
  @param event   The event this sound represents.
  @param account The account the sound is being played for.
  @return @c TRUE if the sound should not be played, or @c FALSE otherwise.
 @endsignaldef

 */
// vim: syntax=c tw=75 et