Changeset 1471 for trunk/psLib/src/collections/psArray.h

Timestamp:

Aug 11, 2004, 9:47:31 AM (22 years ago)

Author:

desonia

Message:

doxygen comment cleanup.

File:

• trunk/psLib/src/collections/psArray.h (modified) (5 diffs)

trunk/psLib/src/collections/psArray.h

@@ -12 +12 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-09 23:40:55 $
+ *  @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-08-11 19:47:31 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -54 +54 @@
  *
  */
-psArray* psArrayAlloc(unsigned int nalloc       ///< Total number of elements to make available.
-                     );
+psArray* psArrayAlloc(
+    unsigned int nalloc                ///< Total number of elements to make available.
+);
 
 /** Reallocate an array.
@@ -65 +66 @@
  *
  */
-psArray* psArrayRealloc(unsigned int nalloc,    ///< Total number of elements to make available.
-                        psArray* restrict psArr        ///< array to reallocate.
-                       );
+psArray* psArrayRealloc(
+    unsigned int nalloc,               ///< Total number of elements to make available.
+    psArray* restrict psArr            ///< array to reallocate.
+);
 
 /** Deallocate/Dereference elements of an array.
@@ -76 +78 @@
  *
  */
-void psArrayElementFree(psArray* restrict psArr        ///< Void pointer array to destroy.
-                       );
+void psArrayElementFree(
+    psArray* restrict psArr            ///< Void pointer array to destroy.
+);
 
 /** Sort the array according to an external compare function.
@@ -84 +87 @@
  *  to specify how the objects on the array should be sorted.
  *
+ *  The comparison function must return an integer less than, equal to, or 
+ *  greater than zero if the first argument is considered to be respectively 
+ *  less than, equal to, or greater than the second. 
+ *
+ *  If two members compare as equal, their order in the sorted array is 
+ *  undefined.
+ *
  *  @return psArray* The sorted array.
  */
-psArray* psArraySort(psArray* in, psComparePtrFcn compare);
+psArray* psArraySort(
+    psArray* in,                       ///< input array to sort.
+    psComparePtrFcn compare            ///< the compare function
+);
 
 /// @}