Updated notiDaemon documentation

src/ccDaemon/ccDaemon.vala

@@ -48,7 +48,6 @@ namespace SwayNotificatonCenter {
         }
 
         public void close_all_notifications () throws DBusError, IOError {
-            controlCenter.close_all_notifications ();
             notiDaemon.close_all_notifications ();
         }
 

src/notiDaemon/notiDaemon.vala

@@ -29,27 +29,35 @@ namespace SwayNotificatonCenter {
             }
         }
 
+        /** 
+         * Changes the popup-notification window visibility.
+         * Closes all notifications and hides window if `value` is false */
         public void set_noti_window_visibility (bool value)
         throws DBusError, IOError {
             notiWindow.change_visibility (value);
         }
 
+        /** Toggles the current Do Not Disturb state */
         public bool toggle_dnd () throws DBusError, IOError {
             on_dnd_toggle (dnd = !dnd);
             return dnd;
         }
 
+        /** Sets the current Do Not Disturb state */
         public void set_dnd (bool state) throws DBusError, IOError {
             on_dnd_toggle (state);
             dnd = state;
         }
 
+        /** Gets the current Do Not Disturb state */
         public bool get_dnd () throws DBusError, IOError {
             return dnd;
         }
 
+        /** Called when Do Not Disturb state changes */
         public signal void on_dnd_toggle (bool dnd);
 
+        /** Method to close notification and send DISMISSED signal */
         public void manually_close_notification (uint32 id, bool timeout)
         throws DBusError, IOError {
             notiWindow.close_notification (id);
@@ -59,15 +67,51 @@ namespace SwayNotificatonCenter {
             }
         }
 
+        /** Closes all popup and controlcenter notifications */
         public void close_all_notifications () throws DBusError, IOError {
             notiWindow.close_all_notifications ();
+            ccDaemon.controlCenter.close_all_notifications ();
         }
 
         /*
-         * Specification
+         * D-Bus Specification
          * https://specifications.freedesktop.org/notification-spec/latest/ar01s09.html
          */
 
+        /**
+         * It returns an array of strings. Each string describes an optional
+         * capability implemented by the server.
+         *
+         * New vendor-specific caps may be specified as long as they start with
+         * "x-vendor". For instance, "x-gnome-foo-cap". Capability names must
+         * not contain spaces. They are limited to alpha-numeric characters
+         * and dashes ("-").
+         */
+        public string[] GetCapabilities () throws DBusError, IOError {
+            string[] capabilities = {
+                "actions",
+                "body",
+                "body-markup",
+                "body-images",
+                "body-hyperlinks",
+                "persistence",
+            };
+            return capabilities;
+        }
+
+        /**
+         * Sends a notification to the notification server.
+         *
+         * If replaces_id is 0, the return value is a UINT32 that represent
+         * the notification. It is unique, and will not be reused unless a
+         * MAXINT number of notifications have been generated. An acceptable
+         * implementation may just use an incrementing counter for the ID.
+         * The returned ID is always greater than zero. Servers must make
+         * sure not to return zero as an ID.
+         *
+         * If replaces_id is not 0, the returned value is the same value
+         * as replaces_id.
+         */
         public uint32 Notify (string app_name,
                               uint32 replaces_id,
                               string app_icon,
@@ -101,27 +145,32 @@ namespace SwayNotificatonCenter {
                 }
             }
             ccDaemon.controlCenter.add_notification (param, this);
+
+
             return id;
         }
 
+        /**
+         * Causes a notification to be forcefully closed and removed from the
+         * user's view. It can be used, for example, in the event that what
+         * the notification pertains to is no longer relevant, or to cancel a
+         * notification with no expiration time.
+         *
+         * The NotificationClosed signal is emitted by this method.
+         *
+         * If the notification no longer exists, an empty D-BUS Error message
+         * is sent back.
+         */
         public void CloseNotification (uint32 id) throws DBusError, IOError {
             notiWindow.close_notification (id);
             ccDaemon.controlCenter.close_notification (id);
             NotificationClosed (id, ClosedReasons.CLOSED_BY_CLOSENOTIFICATION);
         }
 
-        public string[] GetCapabilities () throws DBusError, IOError {
+        /**
-            string[] capabilities = {
+         * This message returns the information on the server. Specifically, the
-                "actions",
+         * server name, vendor, and version number.
-                "body",
+         */
-                "body-markup",
-                "body-images",
-                "body-hyperlinks",
-                "persistence",
-            };
-            return capabilities;
-        }
-
         public void GetServerInformation (out string name,
                                           out string vendor,
                                           out string version,
@@ -133,8 +182,32 @@ namespace SwayNotificatonCenter {
             spec_version = "1.2";
         }
 
+        /**
+         * A completed notification is one that has timed out, or has been
+         * dismissed by the user.
+         *
+         * The ID specified in the signal is invalidated before the signal
+         * is sent and may not be used in any further communications
+         * with the server.
+         */
         public signal void NotificationClosed (uint32 id, uint32 reason);
 
+        /**
+         * This signal is emitted when one of the following occurs:
+         *
+         * - The user performs some global "invoking" action upon a
+         * notification. For instance, clicking somewhere on the
+         * notification itself.
+         *
+         * - The user invokes a specific action as specified in the original
+         * Notify request. For example, clicking on an action button.
+         *
+         * #Note
+         *
+         * Clients should not assume the server will generate this signal.
+         * Some servers may not support user interaction at all, or may not
+         * support the concept of being able to "invoke" a notification.
+         */
         public signal void ActionInvoked (uint32 id, string action_key);
     }
 }