[Orxonox-commit 1848] r6565 - code/branches/chat/src/libraries/network/packet

[smerkli at orxonox.net]

Author: smerkli
Date: 2010-03-18 22:44:37 +0100 (Thu, 18 Mar 2010)
New Revision: 6565

Modified:
   code/branches/chat/src/libraries/network/packet/Chat.h
Log:
Test commit, added a couple of comments.

Modified: code/branches/chat/src/libraries/network/packet/Chat.h
===================================================================
--- code/branches/chat/src/libraries/network/packet/Chat.h	2010-03-18 21:07:48 UTC (rev 6564)
+++ code/branches/chat/src/libraries/network/packet/Chat.h	2010-03-18 21:44:37 UTC (rev 6565)
@@ -40,17 +40,31 @@
 class _NetworkExport Chat : public Packet
 {
 public:
+  /* constructors */
   Chat( const std::string& message, unsigned int playerID );
   Chat( uint8_t* data, unsigned int clientID );
+
+  /* destructor */
   ~Chat();
 
+  /* get size of packet */
   inline unsigned int getSize() const;
+
+  /* process chat message packet and remove it afterwards */
   bool process();
 
+  /* Get the length of the message (not the full size of the packet) */
   unsigned int getMessageLength(){ return messageLength_; };
+
+  /* return message content */
   unsigned char *getMessage();
+
 private:
+
+  /* Message length */
   uint32_t messageLength_;
+
+  /* Client ID (an integral value for identification) */
   unsigned int clientID_;
 };