view doc/sound-signals.dox @ 22493:2c757739ee77

Fix a problem with our configure check for sys/sysctl.h on OpenBSD 4.2. It was printing the following message: checking sys/sysctl.h usability... no checking sys/sysctl.h presence... yes configure: WARNING: sys/sysctl.h: present but cannot be compiled configure: WARNING: sys/sysctl.h: check for missing prerequisite headers? configure: WARNING: sys/sysctl.h: see the Autoconf documentation configure: WARNING: sys/sysctl.h: section "Present But Cannot Be Compiled" configure: WARNING: sys/sysctl.h: proceeding with the preprocessor's result configure: WARNING: sys/sysctl.h: in the future, the compiler will take precedence configure: WARNING: ## ------------------------------ ## configure: WARNING: ## Report this to [e-mail] ## configure: WARNING: ## ------------------------------ ## Turns out sys/sysctl.h on OpenBSD 4.2 requires that sys/param.h be included for it to compile. This was reported to our devel mailing list by David Hill on December 11th, 2007. See http://www.gnu.org/software/autoconf/manual/autoconf.html#Generic-Headers for the documentation on AC_CHECK_HEADERS

/** @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