Changeset 11099 for code/trunk/src/modules/notifications

Timestamp:

Jan 27, 2016, 6:50:51 PM (9 years ago)

Author:

muemart

Message:

Fix loads of doxygen warnings and other documentation issues

Location:

code/trunk/src/modules/notifications

Files:

• NotificationDispatcher.h (modified) (1 diff)
• NotificationQueue.cc (modified) (2 diffs)

code/trunk/src/modules/notifications/NotificationDispatcher.h

@@ -103 +103 @@
             /**
             @brief Set the NotificationDispatcher to broadcast.
-            @param broadcast Whether the NotificationDispatcher is set to broadcast or singlecast.
+            @param v Whether the NotificationDispatcher is set to broadcast or singlecast.
             */
             void setBroadcasting(bool v)

code/trunk/src/modules/notifications/NotificationQueue.cc

@@ -49 +49 @@
     @brief
         Default constructor. Registers and initializes the object.
-    @param creator
-        The creator of the NotificationQueue.
     */
     NotificationQueue::NotificationQueue(Context* context) : BaseObject(context), Synchronisable(context), registered_(false)
@@ -65 +63 @@
         this->registerVariables();
     }
-
-    // TODO move to docu.
-    /**
-    @brief
-        Constructor. Registers and initializes the object.
-    @param creator
-        The creator of the NotificationQueue
-    @param name
-        The name of the new NotificationQueue. It needs to be unique
-    @param senders
-        The senders that are targets of this NotificationQueue, i.e. the names of senders whose Notifications this NotificationQueue displays.
-        The senders need to be seperated by commas.
-    @param size
-        The size (the maximum number of displayed Notifications) of this NotificationQueue.
-    @param displayTime
-        The time during which a Notification is (at most) displayed.
-    */
 
     /**