Documented memory_test & Network

include/Network.h

@@ -1,328 +1,113 @@
-/* -*- Mode: C++; tab-width: 3; indent-tabs-mode: t; c-basic-offset: 3 -*- */
-/*================================================================
+/*!
+ * \file include/Network.h
+ * \brief Networking Singleton class
  *
- * Project : UnRaider
- * Author  : Terry 'Mongoose' Hendrix II
- * Website : http://www.westga.edu/~stu7440/
- * Email   : stu7440@westga.edu
- * Object  : Network
- * License : No use w/o permission (C) 2002 Mongoose
- * Comments:
- *
- *
- *           This file was generated using Mongoose's C++
- *           template generator script.  <stu7440@westga.edu>
- *
- *-- History ------------------------------------------------
- *
- * 2002.06.21:
- * Mongoose - Created
- ================================================================*/
-
+ * \author Mongoose
+ */
 
 #ifndef _NETWORK_H_
 #define _NETWORK_H_
 
-/*----------------------------------------------
- * The packet holds the data for the network
- *  layer.  This is encapsulated in the frame.
+/*!
+ * \brief The packet holds the data for the network.
  *
- * data  - a short (32 char) string
- ---------------------------------------------*/
-typedef struct network_packet_s
-{
+ * This is encapsulated in the frame.
+ */
+typedef struct network_packet_s {
     char send;
     unsigned int port;
     unsigned int cid;
-    char  data[32];
+    char  data[32];    //!< A short (32 char) string
     float pos[3];
     float pitch;
     float yaw;
     int aframe;
     int bframe;
     int view_model;
-
-    char gurantee; // TCP like
-
+    char gurantee;     //!< TCP like
 } network_packet_t;
 
-
-/*----------------------------------------------
- * The frame holds the data for the datalink
- *  layer.  This goes over the line.
+/*!
+ * \brief The frame holds the data for the datalink layer.
  *
- * header - The header flags
- * seq    - The sequence number
- * data   - The packet for the NL
- ---------------------------------------------*/
-typedef struct network_frame_s
-{
-    unsigned int header;
-    unsigned int seq;
+ * This goes over the line.
+ */
+typedef struct network_frame_s {
+    unsigned int header;   //!< The header flags
+    unsigned int seq;      //!< The sequence number
     unsigned int uid;
-
-    network_packet_t data;
-
+    network_packet_t data; //!< The packet for the NL
 } network_frame_t;
 
-
 void from_network_layer(network_packet_t *p, unsigned int *last_id);
 void to_network_layer(network_packet_t p);
 
-
 void killNetworkSingleton();
 
 #define REMOTE_HOST_STR_SZ 64
 #define BIND_HOST_STR_SZ 64
 
-
-class Network
-{
- public:
-
-    ////////////////////////////////////////////////////////////
-    // Constructors ( Singleton )
-    ////////////////////////////////////////////////////////////
-
+/*!
+ * \brief Networking Singleton class
+ */
+class Network {
+public:
+    /*!
+     * \brief Get the Singleton or create it on first use
+     * \returns Singleton of type Network
+     */
     static Network *Instance();
-    /*------------------------------------------------------
-     * Pre  :
-     * Post : Constructs the object of Network or
-     *        returns pointer to it if previously allocated
-     *
-     *-- History ------------------------------------------
-     *
-     * 2001.08.24:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
+    /*!
+     * \brief Deconstructs an object of Network
+     */
     ~Network();
-    /*------------------------------------------------------
-     * Pre  : Network object is allocated
-     * Post : Deconstructs an object of Network
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.06.21:
-     * Mongoose - Created
-     ------------------------------------------------------*/
-
-    ////////////////////////////////////////////////////////////
-    // Public Accessors
-    ////////////////////////////////////////////////////////////
 
     network_frame_t &getPiggyBack();
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.03:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
     unsigned int getUID();
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.03:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
     float getRandom(float from, float to);
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.03:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
     int getPort();
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.03:
-     * Mongoose - Created
-     ------------------------------------------------------*/
-
-    ////////////////////////////////////////////////////////////
-    // Public Mutators
-    ////////////////////////////////////////////////////////////
 
     void setDebug(bool toggle);
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.12.15:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
     void setPort(unsigned int port);
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.03:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
     void setBindHost(char *s);
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.10:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
     void setRemoteHost(char *s);
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.03:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
     void killServerThread();
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.03:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
     void killClientThread();
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.03:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
     void spawnServerThread();
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.03:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
     void spawnClientThread();
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.03:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
     int runServer();
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.03:
-     * Mongoose - Created
-     ------------------------------------------------------*/
 
     void runClient();
-    /*------------------------------------------------------
-     * Pre  :
-     * Post :
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.09.03:
-     * Mongoose - Created
-     ------------------------------------------------------*/
-
- protected:
-
-    ////////////////////////////////////////////////////////////
-    // Constructors ( Singleton )
-    ////////////////////////////////////////////////////////////
 
+protected:
+    /*!
+     * \brief Constructs an object of Network
+     */
     Network();
-    /*------------------------------------------------------
-     * Pre  :
-     * Post : Constructs an object of Network
-     *
-     *-- History ------------------------------------------
-     *
-     * 2002.06.21:
-     * Mongoose - Created
-     ------------------------------------------------------*/
-
-
-    ////////////////////////////////////////////////////////////
-    // Protected Mutators
-    ////////////////////////////////////////////////////////////
-
- private:
-
-    ////////////////////////////////////////////////////////////
-    // Private Accessors
-    ////////////////////////////////////////////////////////////
-
-
-    ////////////////////////////////////////////////////////////
-    // Private Mutators
-    ////////////////////////////////////////////////////////////
-
-
-    static Network *mInstance;      /* Singleton use */
 
+private:
+    static Network *mInstance;            //!< Singleton use
     bool mSpawnedClient;
-
     bool mSpawnedServer;
-
     int mPort;
-
     char mRemoteHost[REMOTE_HOST_STR_SZ];
-
     char mBindHost[BIND_HOST_STR_SZ];
-
     bool mPiggyBack;
-
     bool mNetworkReliable;
-
     bool mKillClient;
-
     bool mKillServer;
-
     bool mDebug;
 };
 

include/memory_test.h

@@ -1,29 +1,15 @@
-/* -*- Mode: C++; tab-width: 3; indent-tabs-mode: t; c-basic-offset: 3 -*- */
-/*================================================================
+/*!
+ * \file include/memory_test.h
+ * Memory testing Toolkit
  *
- * Project : MTK
- * Author  : Terry 'Mongoose' Hendrix II
- * Website : http://www.westga.edu/~stu7440/
- * Email   : stu7440@westga.edu
- * Object  :
- * License : No use w/o permission (C) 2002 Mongoose
- * Comments: Memory testing tool kit
- *
- *
- *           This file was generated using Mongoose's C++
- *           template generator script.  <stu7440@westga.edu>
- *
- *-- History ------------------------------------------------
- *
- * 2002.03.27:
- * Mongoose - Created
- ================================================================*/
-
-#include <cstddef>
+ * \author Mongoose
+ */
 
 #ifndef _MEMORY_TEST_H_
 #define _MEMORY_TEST_H_
 
+#include <cstddef>
+
 #if defined(DEBUG_MEMORY) && !defined(UNIT_TEST_MEMORY)
 
 #define DEBUG_NEW new(__FILE__, __LINE__)
@@ -44,32 +30,20 @@ void operator delete [](void *p);
 #define new DEBUG_NEW
 #define delete DEBUG_DELETE
 
-
 void delete_check(const char *file, int line, int print);
 
 void display_memory_usage();
 
+/*!
+ * \brief Get total memory usage
+ * \returns amount of total memory used
+ */
 long memory_used();
-/*------------------------------------------------------
- * Pre  :
- * Post : Returns amount of total memory used
- *
- *-- History ------------------------------------------
- *
- * 2002.03.27:
- * Mongoose - Created
- ------------------------------------------------------*/
 
+/*!
+ * \brief Dumps raw Tree holding memory accounting
+ */
 void dump_memory_report();
-/*------------------------------------------------------
- * Pre  :
- * Post : Dumps raw Tree holding memory accounting
- *
- *-- History ------------------------------------------
- *
- * 2002.03.27:
- * Mongoose - Created
- ------------------------------------------------------*/
 
 #ifdef DEBUG_MEMORY
 

src/Network.cpp

@@ -1,23 +1,9 @@
-/* -*- Mode: C++; tab-width: 3; indent-tabs-mode: t; c-basic-offset: 3 -*- */
-/*================================================================
+/*!
+ * \file src/Network.cpp
+ * \brief Networking Singleton class
  *
- * Project : UnRaider
- * Author  : Terry 'Mongoose' Hendrix II
- * Website : http://www.westga.edu/~stu7440/
- * Email   : stu7440@westga.edu
- * Object  : Network
- * License : No use w/o permission (C) 2002 Mongoose
- * Comments:
- *
- *
- *           This file was generated using Mongoose's C++
- *           template generator script.  <stu7440@westga.edu>
- *
- *-- History -------------------------------------------------
- *
- * 2002.06.21:
- * Mongoose - Created
- =================================================================*/
+ * \author Mongoose
+ */
 
 #include <Network.h>
 
@@ -691,13 +677,3 @@ void Network::runClient()
     mKillServer = false;
 }
 
-
-////////////////////////////////////////////////////////////
-// Private Accessors
-////////////////////////////////////////////////////////////
-
-
-////////////////////////////////////////////////////////////
-// Private Mutators
-////////////////////////////////////////////////////////////
-

src/memory_test.cpp

@@ -1,23 +1,9 @@
-/* -*- Mode: C++; tab-width: 3; indent-tabs-mode: t; c-basic-offset: 3 -*- */
-/*================================================================
+/*!
+ * \file src/memory_test.cpp
+ * Memory testing Toolkit
  *
- * Project : MTK
- * Author  : Terry 'Mongoose' Hendrix II
- * Website : http://www.westga.edu/~stu7440/
- * Email   : stu7440@westga.edu
- * Object  : memory_test
- * License : No use w/o permission (C) 2002 Mongoose
- * Comments: Memory testing tool kit
- *
- *
- *           This file was generated using Mongoose's C++
- *           template generator script.  <stu7440@westga.edu>
- *
- *-- History -------------------------------------------------
- *
- * 2002.03.27:
- * Mongoose - Created
- =================================================================*/
+ * \author Mongoose
+ */
 
 #include <string.h>
 #include <stdio.h>

test/Network.cpp

@@ -1,23 +1,9 @@
-/* -*- Mode: C++; tab-width: 3; indent-tabs-mode: t; c-basic-offset: 3 -*- */
-/*================================================================
+/*!
+ * \file test/Network.cpp
+ * \brief Networking Singleton Unit test
  *
- * Project : UnRaider
- * Author  : Terry 'Mongoose' Hendrix II
- * Website : http://www.westga.edu/~stu7440/
- * Email   : stu7440@westga.edu
- * Object  : Network
- * License : No use w/o permission (C) 2002 Mongoose
- * Comments:
- *
- *
- *           This file was generated using Mongoose's C++
- *           template generator script.  <stu7440@westga.edu>
- *
- *-- History -------------------------------------------------
- *
- * 2002.06.21:
- * Mongoose - Created
- =================================================================*/
+ * \author Mongoose
+ */
 
 #include <Network.h>
 

test/memory_test.cpp

@@ -1,23 +1,9 @@
-/* -*- Mode: C++; tab-width: 3; indent-tabs-mode: t; c-basic-offset: 3 -*- */
-/*================================================================
+/*!
+ * \file test/memory_test.cpp
+ * Memory testing Toolkit Unit test
  *
- * Project : MTK
- * Author  : Terry 'Mongoose' Hendrix II
- * Website : http://www.westga.edu/~stu7440/
- * Email   : stu7440@westga.edu
- * Object  : memory_test
- * License : No use w/o permission (C) 2002 Mongoose
- * Comments: Memory testing tool kit
- *
- *
- *           This file was generated using Mongoose's C++
- *           template generator script.  <stu7440@westga.edu>
- *
- *-- History -------------------------------------------------
- *
- * 2002.03.27:
- * Mongoose - Created
- =================================================================*/
+ * \author Mongoose
+ */
 
 #include <string.h>
 #include <stdio.h>