Changeset 257 for trunk/archive/pslib/include/psStdArrays.h

Timestamp:

Mar 18, 2004, 9:37:58 PM (22 years ago)

Author:

eugene

Message:

code cleanup for Doxygen support & readability

File:

• trunk/archive/pslib/include/psStdArrays.h (modified) (6 diffs)

trunk/archive/pslib/include/psStdArrays.h

@@ -79 +79 @@
 } psFloatArray;
 
-/** Constructor */
+/** Constructor \ingroup DataGroup */
 psFloatArray *psFloatArrayAlloc(int s,  ///< Total number of elements to make available
                                 int n   ///< Number of elements that will be used
     );
-/** Reallocator */
+/** Reallocator \ingroup DataGroup */
 psFloatArray *psFloatArrayRealloc(psFloatArray *myArray, ///< Array to reallocate
                                   int s ///< Total number of elements to make available
     );
-/** Destructor */
+/** Destructor \ingroup DataGroup */
 void psFloatArrayFree(psFloatArray *restrict myArray ///< Array to free
     );
@@ -109 +109 @@
 } psComplexArray;
 
-/** Constructor */
+/** Constructor \ingroup DataGroup */
 psComplexArray *psComplexArrayAlloc(int s, ///< Total number of elements to make available
                                     int n       ///< Number of elements that will be used
     );
-/** Reallocator */
+/** Reallocator \ingroup DataGroup */
 psComplexArray *psComplexArrayRealloc(psComplexArray *myArray, ///< Array to reallocate
                                       int s     ///< Total number of elements to make available
     );
-/** Destructor */
+/** Destructor \ingroup DataGroup */
 void psComplexArrayFree(psComplexArray *restrict myArray ///< Array to free
     );
@@ -131 +131 @@
 } psIntArray;
 
-/** Constructor */
+/** Constructor \ingroup DataGroup */
 psIntArray *psIntArrayAlloc(int s,      ///< Total number of elements to make available
                             int n       ///< Number of elements that will be used
     );
-/** Reallocator */
+/** Reallocator \ingroup DataGroup */
 psIntArray *psIntArrayRealloc(psIntArray *myArray, ///< Array to reallocate
                               int s     ///< Total number of elements to make available
     );
-/** Destructor */
+/** Destructor \ingroup DataGroup */
 void psIntArrayFree(psIntArray *restrict myArray ///< Array to free
     );
@@ -153 +153 @@
 } psDoubleArray;
 
-/** Constructor */
+/** Constructor \ingroup DataGroup */
 psDoubleArray *psDoubleArrayAlloc(int s, ///< Total number of elements to make available
                                   int n ///< Number of elements that will be used
     );
-/** Reallocator */
+/** Reallocator \ingroup DataGroup */
 psDoubleArray *psDoubleArrayRealloc(psDoubleArray *myArray, ///< Array to reallocate
                                     int s       ///< Total number of elements to make available
     );
-/** Destructor */
+/** Destructor \ingroup DataGroup */
 void psDoubleArrayFree(psDoubleArray *restrict myArray ///< Array to free
     );
@@ -175 +175 @@
 } psVectorArray;
 
-/** Constructor */
+/** Constructor \ingroup DataGroup */
 psVectorArray *psVectorArrayAlloc(int s, ///< Total number of elements to make available
                                   int n ///< Number of elements that will be used
     );
-/** Reallocator */
+/** Reallocator \ingroup DataGroup */
 psVectorArray *psVectorArrayRealloc(psVectorArray *myArray, ///< Array to reallocate
                                     int s       ///< Total number of elements to make available
     );
-/** Destructor */
+/** Destructor \ingroup DataGroup */
 void psVectorArrayFree(psVectorArray *restrict myArray ///< Array to free
     );
@@ -200 +200 @@
 } psVoidPtrArray;
 
-/** Constructor */
+/** Constructor \ingroup DataGroup */
 psVoidPtrArray *psVoidPtrArrayAlloc(int n, //!< Number of elements to use
                                     int s //!< Total number of elements
                                     );
-/** Reallocate */
+/** Reallocate \ingroup DataGroup */
 psVoidPtrArray *psVoidPtrArrayRealloc(psVoidPtrArray *arr, //!< Array to reallocate
                                       int n //!< Number of elements
                                       );
-/** Destructor */
+/** Destructor \ingroup DataGroup */
 void psVoidPtrArrayFree(psVoidPtrArray *arr, //!< array to destroy
                         void (*elemFree)(void *) //!< destructor for array data