Mercurial > pidgin.yaz
view pidgin/gtksound.h @ 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 | d25cbbea7fe5 |
children | 02a2e8183b1d |
line wrap: on
line source
/** * @file gtksound.h GTK+ Sound API * @ingroup pidgin */ /* pidgin * * Pidgin is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA */ #ifndef _PIDGINSOUND_H_ #define _PIDGINSOUND_H_ #include "sound.h" /**************************************************************************/ /** @name GTK+ Sound API */ /**************************************************************************/ /*@{*/ /** * Get the prefs option for an event. * * @param event The event. * @return The option. */ const char *pidgin_sound_get_event_option(PurpleSoundEventID event); /** * Get the label for an event. * * @param event The event. * @return The label. */ const char *pidgin_sound_get_event_label(PurpleSoundEventID event); /** * Gets GTK+ sound UI ops. * * @return The UI operations structure. */ PurpleSoundUiOps *pidgin_sound_get_ui_ops(void); /** * Get the handle for the GTK+ sound system. * * @return The handle to the sound system */ void *pidgin_sound_get_handle(void); /** * Returns true Pidgin is using customized sounds * * @return TRUE if non default sounds are used. * * @since 2.6.0 */ gboolean pidgin_sound_is_customized(void); /*@}*/ #endif /* _PIDGINSOUND_H_ */