[Kstars-devel] [kstars] /: Adding documentation for new KSNotify namespace. If I'm going to enforce doxygen documentation, I shall start with myself :-)

[Jasem Mutlaq]

Git commit 351c8b68066f9fec840871da5a85fe9c0b24f16d by Jasem Mutlaq.
Committed on 12/02/2015 at 19:57.
Pushed by mutlaqja into branch 'master'.

Adding documentation for new KSNotify namespace. If I'm going to enforce doxygen documentation, I shall start with myself :-)

CCMAIL:kstars-devel at kde.org

M  +1    -0    Mainpage.dox
M  +16   -1    kstars/auxiliary/ksnotify.h

http://commits.kde.org/kstars/351c8b68066f9fec840871da5a85fe9c0b24f16d

diff --git a/Mainpage.dox b/Mainpage.dox
index 91cda59..002749c 100644
--- a/Mainpage.dox
+++ b/Mainpage.dox
@@ -89,6 +89,7 @@ The "model" is encapsulated in the KStarsData class, and the "view" is encapsula
     - FocusDialog
     - \ref KSWizard Wizard
     - Settings: OpsCatalog, OpsAdvanced, OpsColors, OpsGuides, OpsSatellites, OpsSolarSystem, OpsSupernovae, OpsINDI, OpsEkos
+    - \ref KSNotify "Notifications"
 
 \subsection Scripting Scripting
     - \ref DBusInterface DBus Interface
diff --git a/kstars/auxiliary/ksnotify.h b/kstars/auxiliary/ksnotify.h
index ff62eca..931b147 100644
--- a/kstars/auxiliary/ksnotify.h
+++ b/kstars/auxiliary/ksnotify.h
@@ -1,11 +1,26 @@
 #ifndef KSNOTIFY_H
 #define KSNOTIFY_H
 
+/**
+ * @namespace KSNotify
+ *
+ * Provides capability to play notification sounds for certain types of events such are OK, Error, and File Received.
+ */
 namespace KSNotify
 {
 
-    typedef enum { NOTIFY_OK, NOTIFY_ERROR, NOTIFY_FILE_RECEIVED} Type;
+    /**
+    * Supported notification types.
+    */
+    typedef enum { NOTIFY_OK,           /**< Operation completed OK */
+                   NOTIFY_ERROR,        /**< Operation completed with error */
+                   NOTIFY_FILE_RECEIVED /**< File downloaded successfuly from device or internet */
+                 } Type;
 
+    /**
+     * @brief play a notification
+     * @param type type of notification
+     */
     void play(Type type);
 
 }