Changeset 7489 for code/trunk/src/modules/notifications/dispatchers

Timestamp:

Sep 24, 2010, 4:01:04 PM (14 years ago)

Author:

dafrick

Message:

Mostly more documentation.

Location:

code/trunk/src/modules/notifications/dispatchers

Files:

• CommandNotification.cc (modified) (2 diffs)
• CommandNotification.h (modified) (2 diffs)

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

@@ -64 +64 @@
     CommandNotification::~CommandNotification()
     {
-        
+
     }
 
@@ -114 +114 @@
         Returns a human readable version of the input binding.
     */
+    //TODO: Move to KeyBinderManager...
     const std::string& CommandNotification::bindingNiceifyer(const std::string& binding)
     {

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

@@ -46 +46 @@
     @brief
         This class implements a method of displaying a Notification with information to an input command and the key the command is mapped to.
-        The message that is displayed is a string made out uf the concatenation of the preMessage, the key the specified command is mapped to and the postMessage.
+        The message that is displayed is a string made out of the concatenation of the preMessage, the key the specified command is mapped to and the postMessage.
 
         In use it would like this:
@@ -120 +120 @@
                  { this->postMessage_ = message; }
 
-            const std::string& bindingNiceifyer(const std::string& binding);
+            const std::string& bindingNiceifyer(const std::string& binding); //!< Transforms the input binding into a human readable form.
 
     };