Changeset 5525 in orxonox.OLD

Timestamp:

Nov 9, 2005, 5:17:27 PM (18 years ago)

Author:

patrick

Message:

network/lib/network: some help added to the network manager

Location:

branches/network/src/lib/network

Files:

• network_manager.cc (modified) (3 diffs)
• network_manager.h (modified) (1 diff)

branches/network/src/lib/network/network_manager.cc

@@ -14 +14 @@
 */
 
-#define DEBUG_SPECIAL_MODULE DEBUG_MODULE_NETWORK
 
+/* this is for debug output. It just says, that all calls to PRINT() belong to the DEBUG_MODULE_NETWORK module
+   For more information refere to https://www.orxonox.net/cgi-bin/trac.cgi/wiki/DebugOutput 
+*/
+#define DEBUG_MODULE_NETWORK 
+
+
+/* include your own header */
 #include "network_manager.h"
 
+/* using namespace std is default, this needs to be here */
 using namespace std;
 
 
+/************************************
+  What you will see here are the function definitions from the header file (network_manager.h) with doxygen documentation. Here is an example:
+ 
+ 
+ In file network_manager.h  
 
+ class NetworkManager
+ {
+   int doSomeStuff(float argument, float* pointer);
+ }   
 
+ will be implemented in the source file as follows:
+
+ In file network_manager.cc
+
+ / **
+  *  this is the short description for this function: it just does some stuff
+  * @param argument: this is the first argument, stuff...
+  * @param pointer:  this is the pointer to nowhereland   
+  * return: whatever the function returns: for example an index, number, etc. 
+  * /    
+ int NetworkManager::doSomeStuff(float argument, float* pointer)
+ {
+   // whaterver you want to do 
+ }        
+ 
+
+ if you want to make automake compile your files: you will want to add the file names to the local Makefile.am
+ 
+ ************************************/
+
+                
+                
+                
 /**
  *  standard constructor
@@ -56 +95 @@
  * @param synchronizeable: reference to the sync object
  */
-void NetworkManager::establishConnection()
+void NetworkManager::establishConnection(/* address, port, object reference*/)
 {}
 
@@ -71 +110 @@
  * @param listener: the reference to the listener to be added
  */
-void NetworkManager::registerListener()
+void NetworkManager::registerListener(/* listener reference*/)
 {}
 

branches/network/src/lib/network/network_manager.h

@@ -21 +21 @@
  
   void initialize();
-  void sthudown();
-  void establishConnection();
+  void shutdown();
+  void establishConnection(/* address, port, object reference*/);
   void shutdownConnection();