Changeset 153 for trunk/archive/pslib/include/psSort.h

Timestamp:

Mar 9, 2004, 12:28:16 PM (22 years ago)

Author:

Paul Price

Message:

Doxygen-ated the source files.

File:

• trunk/archive/pslib/include/psSort.h (modified) (1 diff)

trunk/archive/pslib/include/psSort.h

@@ -6 +6 @@
 /* Sorting */
 
-/* Sort an array */
-/* Inputs not restrict-ed to allow sort in place */
+/** Sort an array. Inputs not restrict-ed to allow sort in place */
 psFloatArray *
-psSort(psFloatArray *out,               // Sorted array to return. May be NULL
-       const psFloatArray *myArray      // Array to sort
+psSort(psFloatArray *out,               //!< Sorted array to return. May be NULL
+       const psFloatArray *myArray      //!< Array to sort
        );
 
-/* Sort an array, along with some other stuff */
-/* Returns an index array */
+/** Sort an array, along with some other stuff.  Returns an index array */
 psIntArray *
-psCoSort(psIntArray *restrict out;      // Output index array (may be NULL)
-         const psFloatArray *restrict myArray // Array to sort
+psCoSort(psIntArray *restrict out;      //!< Output index array (may be NULL)
+         const psFloatArray *restrict myArray //!< Array to sort
          );