Index: trunk/psLib/src/collections/psCompare.h
===================================================================
--- trunk/psLib/src/collections/psCompare.h	(revision 1441)
+++ trunk/psLib/src/collections/psCompare.h	(revision 1473)
@@ -9,6 +9,6 @@
  *  @ingroup Compare
  *
- *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-09 23:40:55 $
+ *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-08-11 19:58:11 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -26,5 +26,8 @@
  *                   than, equal to, or greater than the second. 
  */
-typedef int (*psComparePtrFcn) (const void **a, const void **b);
+typedef int (*psComparePtrFcn) (
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** A comparison function for sorting.
@@ -34,5 +37,8 @@
  *                   than, equal to, or greater than the second. 
  */
-typedef int (*psCompareFcn) (const void *a, const void *b);
+typedef int (*psCompareFcn) (
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
 
 /** Compare function of psS8 data.  For use with psListSort.
@@ -42,5 +48,8 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareS8Ptr(const void **a, const void **b);
+int psCompareS8Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psS16 data.  For use with psListSort.
@@ -50,5 +59,8 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareS16Ptr(const void **a, const void **b);
+int psCompareS16Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psS32 data.  For use with psListSort.
@@ -58,5 +70,8 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareS32Ptr(const void **a, const void **b);
+int psCompareS32Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psS64 data.  For use with psListSort.
@@ -66,5 +81,8 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareS64Ptr(const void **a, const void **b);
+int psCompareS64Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psU8 data.  For use with psListSort.
@@ -74,5 +92,8 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareU8Ptr(const void **a, const void **b);
+int psCompareU8Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psU16 data.  For use with psListSort.
@@ -82,5 +103,8 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareU16Ptr(const void **a, const void **b);
+int psCompareU16Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psU32 data.  For use with psListSort.
@@ -90,5 +114,8 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareU32Ptr(const void **a, const void **b);
+int psCompareU32Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psU64 data.  For use with psListSort.
@@ -98,5 +125,8 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareU64Ptr(const void **a, const void **b);
+int psCompareU64Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psF32 data.  For use with psListSort.
@@ -106,5 +136,8 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareF32Ptr(const void **a, const void **b);
+int psCompareF32Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psF64 data.  For use with psListSort.
@@ -114,5 +147,8 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareF64Ptr(const void **a, const void **b);
+int psCompareF64Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psS8 data.  For use with psListSort for descending ordering.
@@ -122,5 +158,8 @@
  *                   than, equal to, or less than the second. 
  */
-int psCompareDescendingS8Ptr(const void **a, const void **b);
+int psCompareDescendingS8Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psS16 data.  For use with psListSort for descending ordering.
@@ -130,5 +169,8 @@
  *                   than, equal to, or less than the second. 
  */
-int psCompareDescendingS16Ptr(const void **a, const void **b);
+int psCompareDescendingS16Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psS32 data.  For use with psListSort for descending ordering.
@@ -138,5 +180,8 @@
  *                   than, equal to, or less than the second. 
  */
-int psCompareDescendingS32Ptr(const void **a, const void **b);
+int psCompareDescendingS32Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psS64 data.  For use with psListSort for descending ordering.
@@ -146,5 +191,8 @@
  *                   than, equal to, or less than the second. 
  */
-int psCompareDescendingS64Ptr(const void **a, const void **b);
+int psCompareDescendingS64Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psU8 data.  For use with psListSort for descending ordering.
@@ -154,5 +202,8 @@
  *                   than, equal to, or less than the second. 
  */
-int psCompareDescendingU8Ptr(const void **a, const void **b);
+int psCompareDescendingU8Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psU16 data.  For use with psListSort for descending ordering.
@@ -162,5 +213,8 @@
  *                   than, equal to, or less than the second. 
  */
-int psCompareDescendingU16Ptr(const void **a, const void **b);
+int psCompareDescendingU16Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psU32 data.  For use with psListSort for descending ordering.
@@ -170,5 +224,8 @@
  *                   than, equal to, or lessg than the second. 
  */
-int psCompareDescendingU32Ptr(const void **a, const void **b);
+int psCompareDescendingU32Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psU64 data.  For use with psListSort for descending ordering.
@@ -178,5 +235,8 @@
  *                   than, equal to, or lessg than the second. 
  */
-int psCompareDescendingU64Ptr(const void **a, const void **b);
+int psCompareDescendingU64Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psF32 data.  For use with psListSort for descending ordering.
@@ -186,5 +246,8 @@
  *                   than, equal to, or lessg than the second. 
  */
-int psCompareDescendingF32Ptr(const void **a, const void **b);
+int psCompareDescendingF32Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psF64 data.  For use with psListSort for descending ordering.
@@ -194,5 +257,8 @@
  *                   than, equal to, or lessg than the second. 
  */
-int psCompareDescendingF64Ptr(const void **a, const void **b);
+int psCompareDescendingF64Ptr(
+    const void **a,                    ///< first comparison target
+    const void **b                     ///< second comparison target
+);
 
 /** Compare function of psS8 data.
@@ -202,5 +268,9 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareS8(const void *a, const void *b);
+int psCompareS8(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psS16 data.
@@ -210,5 +280,9 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareS16(const void *a, const void *b);
+int psCompareS16(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psS32 data.
@@ -218,5 +292,9 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareS32(const void *a, const void *b);
+int psCompareS32(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psS64 data.
@@ -226,5 +304,9 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareS64(const void *a, const void *b);
+int psCompareS64(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psU8 data.
@@ -234,5 +316,9 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareU8(const void *a, const void *b);
+int psCompareU8(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psU16 data.
@@ -242,5 +328,9 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareU16(const void *a, const void *b);
+int psCompareU16(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psU32 data.
@@ -250,5 +340,9 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareU32(const void *a, const void *b);
+int psCompareU32(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psU64 data.
@@ -258,5 +352,9 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareU64(const void *a, const void *b);
+int psCompareU64(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psF32 data.
@@ -266,5 +364,9 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareF32(const void *a, const void *b);
+int psCompareF32(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psF64 data.
@@ -274,5 +376,9 @@
  *                   than, equal to, or greater than the second. 
  */
-int psCompareF64(const void *a, const void *b);
+int psCompareF64(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psS8 data.
@@ -282,5 +388,9 @@
  *                   than, equal to, or less than the second. 
  */
-int psCompareDescendingS8(const void *a, const void *b);
+int psCompareDescendingS8(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psS16 data.
@@ -290,5 +400,9 @@
  *                   than, equal to, or less than the second. 
  */
-int psCompareDescendingS16(const void *a, const void *b);
+int psCompareDescendingS16(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psS32 data.
@@ -298,5 +412,9 @@
  *                   than, equal to, or less than the second. 
  */
-int psCompareDescendingS32(const void *a, const void *b);
+int psCompareDescendingS32(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psS64 data.
@@ -306,5 +424,9 @@
  *                   than, equal to, or less than the second. 
  */
-int psCompareDescendingS64(const void *a, const void *b);
+int psCompareDescendingS64(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psU8 data.
@@ -314,5 +436,9 @@
  *                   than, equal to, or less than the second. 
  */
-int psCompareDescendingU8(const void *a, const void *b);
+int psCompareDescendingU8(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psU16 data.
@@ -322,5 +448,9 @@
  *                   than, equal to, or less than the second. 
  */
-int psCompareDescendingU16(const void *a, const void *b);
+int psCompareDescendingU16(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psU32 data.
@@ -328,7 +458,11 @@
  *  @return int      an integer less than, equal to, or greater than zero if 
  *                   the first argument is considered to be respectively greater 
- *                   than, equal to, or lessg than the second. 
- */
-int psCompareDescendingU32(const void *a, const void *b);
+ *                   than, equal to, or less than the second. 
+ */
+int psCompareDescendingU32(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psU64 data.
@@ -336,7 +470,11 @@
  *  @return int      an integer less than, equal to, or greater than zero if 
  *                   the first argument is considered to be respectively greater 
- *                   than, equal to, or lessg than the second. 
- */
-int psCompareDescendingU64(const void *a, const void *b);
+ *                   than, equal to, or less than the second. 
+ */
+int psCompareDescendingU64(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psF32 data.
@@ -344,7 +482,11 @@
  *  @return int      an integer less than, equal to, or greater than zero if 
  *                   the first argument is considered to be respectively greater 
- *                   than, equal to, or lessg than the second. 
- */
-int psCompareDescendingF32(const void *a, const void *b);
+ *                   than, equal to, or less than the second. 
+ */
+int psCompareDescendingF32(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /** Compare function of psF64 data.
@@ -352,7 +494,11 @@
  *  @return int      an integer less than, equal to, or greater than zero if 
  *                   the first argument is considered to be respectively greater 
- *                   than, equal to, or lessg than the second. 
- */
-int psCompareDescendingF64(const void *a, const void *b);
+ *                   than, equal to, or less than the second. 
+ */
+int psCompareDescendingF64(
+    const void *a,                     ///< first comparison target
+    const void *b                      ///< second comparison target
+);
+
 
 /// @}