Changeset 974 for trunk/psLib/src/pslib.h

Timestamp:

Jun 9, 2004, 3:58:06 PM (22 years ago)

Author:

desonia

Message:

Added doxygen group tags.

File:

• trunk/psLib/src/pslib.h (modified) (2 diffs)

trunk/psLib/src/pslib.h

@@ -8 +8 @@
  *  @author Eric Van Alst, MHPCC
  *   
- *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-06-08 19:08:40 $
+ *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-06-10 01:58:06 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -22 +22 @@
 
 // System Utilities
+
+/// @defgroup SysUtils System Utilities
+/// @{
+
+/** @defgroup MemoryManagement Memory Management Utilities
+ *
+ *  This is the generic memory management system put inbetween the user's high level code and the OS-level
+ *  memory allocation routines.  This system adds such features as callback routines for memory error events,
+ *  tracing capabilities, and reference counting.
+ *
+ *  @ingroup SysUtils
+ */
+
 #include "psMemory.h"
+
+/// @defgroup LogTrace Tracing and Logging
+/// @ingroup SysUtils
 #include "psLogMsg.h"
 #include "psTrace.h"
+
+/// @defgroup ErrorHandling Error Handling
+/// @ingroup SysUtils
 #include "psAbort.h"
 #include "psError.h"
+
 #include "psString.h"
 
+/// @}
+
 // Collections
+/// @defgroup DataContainer Data Containers
+/// @{
+
 #include "psType.h"
-#include "psVector.h"
-#include "psImage.h"
-#include "psBitSet.h"
-#include "psSort.h"
-#include "psHash.h"
+
+/// @defgroup LinkedList Linked List
+/// @ingroup DataContainer
 #include "psList.h"
 
+/// @defgroup HashTable Hash Table
+/// @ingroup DataContainer
+#include "psHash.h"
+
+/// @defgroup Vector Vector Container
+/// @ingroup DataContainer
+#include "psVector.h"
+
+/// @defgroup Image Image Container
+/// @ingroup DataContainer
+#include "psImage.h"
+
+/// @defgroup BitSet Bit Set
+/// @ingroup DataContainer
+#include "psBitSet.h"
+
+/// @defgroup Sort Sorting Functions
+/// @ingroup DataContainer
+#include "psSort.h"
+/// @}
+
 // Data Manipulation
+/// @defgroup DataManip Data Manipulation
+/// @{
+
+/// @defgroup Stats Statistic Functions
+/// @ingroup DataManip
 #include "psStats.h"
+
+/// @defgroup Matrix Matrix Operations
+/// @ingroup DataManip
 #include "psMatrix.h"
+
+/// @defgroup Transform Fourier Transform
+/// @ingroup DataManip
 #include "psFFT.h"
+
+/// @defgroup ImageIO Image File I/O
+/// @ingroup DataManip
 #include "psImageIO.h"
 
-/******************************************************************************/
-/*  DEFINE STATEMENTS                                                         */
-/******************************************************************************/
-
-// None
-
-/******************************************************************************/
-/*  TYPE DEFINITIONS                                                          */
-/******************************************************************************/
-
-// None
-
-/*****************************************************************************/
-/* FUNCTION PROTOTYPES                                                       */
-/*****************************************************************************/
+/// @}
 
 #endif