annotate doc/sound-signals.dox @ 29928:cead5610c89a

Add a cast to silence this warning. perl-handlers.c: In function ¡Æperl_signal_cb¡Ç: perl-handlers.c:306: warning: passing argument 2 of ¡Æpurple_perl_sv_from_vargs¡Ç from incompatible pointer type perl-common.h:69: note: expected ¡Æstruct __va_list_tag (*)[1]¡Ç but argument is of type ¡Æstruct __va_list_tag *¡Ç This may not be the most elegant solution, but va_args aren't really elegant, and this solution is at least easy. Thanks very much to the expert bug reporting and research done by dharding! Fixes #11431 (that ticket has a lot of information about this change)

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 @see sound.h

 <hr>

 @signaldef playing-sound-event
  @signalproto
gboolean (*playing_sound_event)(PurpleSoundEventID event, PurpleAccount *account);
  @endsignalproto
  @signaldesc
   Emitted when libpurple 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.doxygen tw=75 et