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

Timestamp:

Oct 17, 2010, 10:50:43 PM (14 years ago)

Author:

dafrick

Message:

Resolving some TODOs and doing some additional cleanup. Almost done now…

Location:

code/trunk/src/modules/notifications

Files:

• Notification.h (modified) (1 diff)
• NotificationDispatcher.cc (modified) (1 diff)
• NotificationDispatcher.h (modified) (2 diffs)
• NotificationManager.cc (modified) (1 diff)
• NotificationManager.h (modified) (1 diff)
• NotificationQueue.h (modified) (3 diffs)
• dispatchers/CommandNotification.h (modified) (1 diff)
• dispatchers/SimpleNotification.h (modified) (1 diff)

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

@@ -49 +49 @@
 
         A Notification is just a datastructure that is used internally by the Notifications module.
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup Notifications
     */
     class _NotificationsExport Notification : public OrxonoxClass

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

@@ -118 +118 @@
         else if(GameMode::isServer())
         {
-            //TODO: This may fail if the object has not been synchronized, yet.
             callMemberNetworkFunction(NotificationDispatcher, dispatch, this->getObjectID(), clientId, clientId);
         }

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

@@ -39 +39 @@
 
 #include <string>
+
 #include "core/BaseObject.h"
 #include "network/synchronisable/Synchronisable.h"
@@ -62 +63 @@
         @endcode
         But keep in mind, that NotificationDispatcher is an abstract class and in this example @ref orxonox::PlayerTrigger "PlayerTrigger" stands for any event that is caused by a @ref orxonox::PlayerTrigger "PlayerTrigger", so instead of @ref orxonox::PlayerTrigger "PlayerTrigger", there could be a @ref orxonox::DistanceTrigger "DistanceTrigger", or a @ref orxonox::DistanceMultiTrigger "DistanceMutliTrigger", or even an @ref orxonox::EventListener "EventListener" that waits for an event coming from any kind of @ref orxonox::PlayerTrigger "PlayerTrigger".
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup Notifications
     */
     class _NotificationsExport NotificationDispatcher : public BaseObject, public Synchronisable

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

@@ -149 +149 @@
         assert(notification);
 
-        std::time_t time = std::time(0); //TODO: Doesn't this expire? //!< Get current time.
+        std::time_t time = std::time(0); // Get current time.
 
         // Add the Notification to the list that holds all Notifications.

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

@@ -53 +53 @@
         It receives, organizes @ref orxonox::Notification "Notifications" and the redistributes them to the specific @ref orxonox::NotificationListener "NotificationListeners".
         It also provides a static function to send @ref orxonox::Notification "Notifications" and works as a liaison between the @ref orxonox::NotificationQueue "NotificationQueues" and the GUI that displays notification, called NotificationLayer.
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup Notifications
     */
     class _NotificationsExport NotificationManager // tolua_export

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

@@ -51 +51 @@
 { // tolua_export
 
-    //! Container to allow easy handling.
+    /**
+    @brief
+        Container to allow easy handling of the @ref orxonox::Notification "Notifications".
+
+    @ingroup Notifications
+    */
     struct NotificationContainer
     {
@@ -58 +63 @@
     };
 
-    //! Struct to allow ordering of @ref orxonox::NotificationContainer "NotificationContainers".
+    /**
+    @brief
+        Struct to allow ordering of @ref orxonox::NotificationContainer "NotificationContainers".
+
+    @ingroup Notifications
+    */
     struct NotificationContainerCompare {
         bool operator() (const NotificationContainer* const & a, const NotificationContainer* const & b) const
@@ -76 +86 @@
     @author
         Damian 'Mozork' Frick
+
+    @ingroup Notifications
     */
     class _NotificationsExport NotificationQueue // tolua_export

code/trunk/src/modules/notifications/dispatchers/CommandNotification.h

@@ -60 +60 @@
         Upon being triggered this would display the @ref orxonox::Notification "Notification" "Please press {the binding of the specified command} to do something".
         For more information on what can be used for @code <PlayerTrigger /> @endcode see the @ref orxonox::NotificationDispatcher "NotificationDispatcher" documentation.
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup NotificationDispatchers
     */
     class _NotificationsExport CommandNotification : public NotificationDispatcher

code/trunk/src/modules/notifications/dispatchers/SimpleNotification.h

@@ -58 +58 @@
         @endcode
         For more information on what can be used for @code <PlayerTrigger /> @endcode see the @ref orxonox::NotificationDispatcher "NotificationDispatcher" documentation.
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup NotificationDispatchers
     */
     class _NotificationsExport SimpleNotification : public NotificationDispatcher