aboutsummaryrefslogtreecommitdiff
path: root/include/notifications/notifications.h
diff options
context:
space:
mode:
authorCharles Kerr <charles.kerr@canonical.com>2014-07-30 17:03:08 -0500
committerCharles Kerr <charles.kerr@canonical.com>2014-07-30 17:03:08 -0500
commit5d6108ee4440881b08b419a1c454b1db57e1d6ce (patch)
tree227166b366c3f1831ec50cd0aefd4719518a5f2d /include/notifications/notifications.h
parentd6b290fda978379fb07285aaddfeb31686735667 (diff)
downloadayatana-indicator-datetime-5d6108ee4440881b08b419a1c454b1db57e1d6ce.tar.gz
ayatana-indicator-datetime-5d6108ee4440881b08b419a1c454b1db57e1d6ce.tar.bz2
ayatana-indicator-datetime-5d6108ee4440881b08b419a1c454b1db57e1d6ce.zip
fix doxygen comments
Diffstat (limited to 'include/notifications/notifications.h')
-rw-r--r--include/notifications/notifications.h8
1 files changed, 3 insertions, 5 deletions
diff --git a/include/notifications/notifications.h b/include/notifications/notifications.h
index c2e2d85..d876a57 100644
--- a/include/notifications/notifications.h
+++ b/include/notifications/notifications.h
@@ -91,16 +91,14 @@ public:
bool supports_actions() const;
/** Show a notification.
- @return nonzero on success, zero on failure. */
+ @return zero on failure, or a key that can be passed to close() */
int show(const Builder& builder);
/** Close a notification.
- @param key the int returned by show()
- @return true if the notification was closed. */
+ @param key the int returned by show() */
void close(int key);
- /** Close all remaining notifications.
- *@return true if all closed successfully. */
+ /** Close all remaining notifications. */
void close_all();
const std::string& app_name() const;