Changeset 11331 for code/branches/Dialog_HS16/src/modules/notifications/dispatchers/Dialogue.cc

Timestamp:

Dec 12, 2016, 3:16:38 PM (7 years ago)

Author:

dmoritz

Message:

Final changes.

File:

• code/branches/Dialog_HS16/src/modules/notifications/dispatchers/Dialogue.cc (modified) (4 diffs)

code/branches/Dialog_HS16/src/modules/notifications/dispatchers/Dialogue.cc

@@ -1 @@
-
-
 
 #include "Dialogue.h"
@@ -15 +13 @@
         RegisterClass(Dialogue);
 
+    /**
+    @brief
+        Default Constructor. Registers the object and initializes variables.
+    */
         Dialogue::Dialogue(Context* context):NotificationDispatcher(context){
                 RegisterObject(Dialogue);
@@ -22 +24 @@
         this->setSyncMode(ObjectDirection::None);
         }
-
+    /**
+    @brief
+        Destructor.
+    */
         Dialogue::~Dialogue()
     {
 
     }
+    /**
+    @brief
+        Method for creating a Dialogue object through XML.
+    */
     void Dialogue::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
@@ -36 +45 @@
         
     }
-     void Dialogue::update()
-   {    
+    /**
+    @brief
+        Passes the name of the picture over to the HUDDialogue class
+    */
+    void Dialogue::update()
+    {    
        for(HUDDialogue* huddialogue : ObjectList<HUDDialogue>())
                        huddialogue->updateTarget(portrait_);
     }
-    
+    /**
+        @brief Creates the notification message,Pconsisting of a speaker and a message, that should be sent upon the Dialgue triggering.
+        @return Returns the notification message.
+    */
     const std::string& Dialogue::createNotificationMessage(void)
                 {