From fc2a42e51afc528e1b0c1c66735df8abc32ac629 Mon Sep 17 00:00:00 2001 From: Patrick von Reth Date: Mon, 29 Jun 2015 21:17:54 +0200 Subject: [PATCH] update doc --- src/libsnore/application.h | 19 +++++++++++-------- src/libsnore/notification/notification.h | 8 +++----- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/src/libsnore/application.h b/src/libsnore/application.h index bb75c0c..baa1bc4 100644 --- a/src/libsnore/application.h +++ b/src/libsnore/application.h @@ -100,14 +100,17 @@ public: bool isValid() const; /** - * Returns application specific hints: - * Key | Value | Required - * ------------- | ----------- | ----------- - * use-markup | Enable markup support for title and message, strings must be html escaped.| Many Backends. - * desktop-entry | The name of the desktop enty associated with the application. | Used for The freedesktop backend. - * windows-app-id | The app id associated with the application. | Needed for the Windows 8 backend [See MSDN Documentation](http://msdn.microsoft.com/en-us/library/windows/apps/dd378459.aspx). - * tray-icon | A QPointer item. | Needed for the System Tray Backend. - * pushover-token | The token associated with your application. | Needed to associate pushover notification with your application, to register your application visit [Pushover](https://pushover.net/apps/build). + * Returns application specific hints. + * Hints are inherited by Notification's. + * Key | Type | Value | Required + * ------------- | ----------- | ----------- | ----------- + * use-markup | QString |Enable markup support for title and message, strings must be html escaped. | Many Backends. + * desktop-entry | QString | The name of the desktop enty associated with the application. | Used for The freedesktop backend. + * windows-app-id | QString | The app id associated with the application. | Needed for the Windows 8 backend [See MSDN Documentation](http://msdn.microsoft.com/en-us/library/windows/apps/dd378459.aspx). + * tray-icon | QPointer | A QSystemTray item. | Needed for the System Tray Backend. + * pushover-token | QString | The token associated with your application. | Needed to associate pushover notification with your application, to register your application visit [Pushover](https://pushover.net/apps/build). + * silent | bool | Don't play notification sounds. | Multiple backends. + * sound | QString | Local uri to a sound file. | Secondary Backend Sound. */ Hint &hints(); diff --git a/src/libsnore/notification/notification.h b/src/libsnore/notification/notification.h index 5457a51..cbc73be 100644 --- a/src/libsnore/notification/notification.h +++ b/src/libsnore/notification/notification.h @@ -232,11 +232,9 @@ public: const Notification::CloseReasons &closeReason(); /** - * Returns notification specific hints: - * Key | Type | Value | Used In - * ------------- | ----------- | ----------- | ----------- - * silent | bool | Don't play notification sounds. | Multiple backends. - * sound | QString | Local uri to a sound file. | Secondary Backend Sound. + * Returns notification specific hints. + * A notification inherits the hints of its application. + * @see Application::hints() */ Hint &hints();