0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add doxygen comments for notifications functions

Browse source
This commit is contained in:
Chris Beck 2014-07-14 13:47:51 -04:00
parent 36327a4d0f
commit 3ddea55e00
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/desktop/notifications.hpp
View file

@ -23,8 +23,23 @@ namespace notifications
{
enum type {CHAT, TURN_CHANGED, OTHER};
/**
* Displays a desktop notification message @message, from @a owner, of type @t.
*
* If it is an appropriate time to send a desktop notification (i.e. the window
* does not have focus and the feature is not disabled by the preferences),
* and wesnoth was compiled with support for this feature, a notification will
* be issued. If there is no support for notifications, this fcn is a no-op.
*
* @note Currently we have support for dbus (linux), windows tray notifications,
* and growl (Apple). To enable one of these, the corresponding compilation unit
* dbus_notification.cpp, growl_notification.cpp, windows_tray_notification.cpp,
* must be compiled, and the corresponding C++ symbol HAVE_LIBDBUS, HAVE_GROWL,
* _WIN32 must be defined for that compilation unit _and for this one_.
*/
void send(const std::string& owner, const std::string& message, type t);
/** Returns whether we were compiled with support for desktop notifications. */
bool available();
}