Mercurial > pidgin.yaz
view doc/sound-signals.dox @ 32635:63e7d226b760
Re-arrange these doxygen comments. For comments longer than a few words,
putting the comment before the variable like this seems cleaner than trying
to cram it on the same line as the variable and using lots of crazy
indentation. Anyone have a strong opinion either way?
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Sun, 18 Sep 2011 20:18:33 +0000 |
parents | e0613cf8c493 |
children |
line wrap: on
line source
/** @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