Changeset 1426 for trunk/psLib/src/collections/psVector.h

Timestamp:

Aug 9, 2004, 12:44:25 PM (22 years ago)

Author:

desonia

Message:

fixed some stupid indent-induced formating problems and added doxygen
comments.

File:

• trunk/psLib/src/collections/psVector.h (modified) (6 diffs)

trunk/psLib/src/collections/psVector.h

@@ -12 +12 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-07 00:06:06 $
+ *  @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-08-09 22:44:25 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -33 +33 @@
 typedef struct
 {
-    psType type;                // /< Type of data.
-    unsigned int nalloc;        // /< Total number of elements available.
-    unsigned int n;             // /< Number of elements in use.
+    psType type;                ///< Type of data.
+    unsigned int nalloc;        ///< Total number of elements available.
+    unsigned int n;             ///< Number of elements in use.
 
     union {
-        psU8 *U8;               // /< Unsigned 8-bit integer data.
-        psU16 *U16;             // /< Unsigned 16-bit integer data.
-        psU32 *U32;             // /< Unsigned 32-bit integer data.
-        psU64 *U64;             // /< Unsigned 64-bit integer data.
-        psS8 *S8;               // /< Signed 8-bit integer data.
-        psS16 *S16;             // /< Signed 16-bit integer data.
-        psS32 *S32;             // /< Signed 32-bit integer data.
-        psS64 *S64;             // /< Signed 64-bit integer data.
-        psF32 *F32;             // /< Single-precision float data.
-        psF64 *F64;             // /< Double-precision float data.
-        psC32 *C32;             // /< Single-precision complex data.
-        psC64 *C64;             // /< Double-precision complex data.
-        psPTR V;                // /< Pointer to data.
-    } data;                     // /< Union for data types.
+        psU8 *U8;               ///< Unsigned 8-bit integer data.
+        psU16 *U16;             ///< Unsigned 16-bit integer data.
+        psU32 *U32;             ///< Unsigned 32-bit integer data.
+        psU64 *U64;             ///< Unsigned 64-bit integer data.
+        psS8 *S8;               ///< Signed 8-bit integer data.
+        psS16 *S16;             ///< Signed 16-bit integer data.
+        psS32 *S32;             ///< Signed 32-bit integer data.
+        psS64 *S64;             ///< Signed 64-bit integer data.
+        psF32 *F32;             ///< Single-precision float data.
+        psF64 *F64;             ///< Double-precision float data.
+        psC32 *C32;             ///< Single-precision complex data.
+        psC64 *C64;             ///< Double-precision complex data.
+        psPTR V;                ///< Pointer to data.
+    } data;                     ///< Union for data types.
 }
 psVector;
@@ -68 +68 @@
  *
  */
-psVector *psVectorAlloc(unsigned int nalloc,    // /< Total number of elements to make available.
-                        psElemType dataType     // /< Type of data to be held by vector.
+psVector *psVectorAlloc(unsigned int nalloc,    ///< Total number of elements to make available.
+                        psElemType dataType     ///< Type of data to be held by vector.
                        );
 
@@ -80 +80 @@
  *
  */
-psVector *psVectorRealloc(unsigned int nalloc,  // /< Total number of elements to make available.
-                          psVector * restrict psVec     // /< Vector to reallocate.
+psVector *psVectorRealloc(unsigned int nalloc,  ///< Total number of elements to make available.
+                          psVector * restrict psVec     ///< Vector to reallocate.
                          );
 
@@ -93 +93 @@
  */
 psVector *psVectorRecycle(psVector * restrict psVec,
-                          // /< Vector to recycle.  If NULL, a new vector is created.  No effort taken to
+                          ///< Vector to recycle.  If NULL, a new vector is created.  No effort taken to
                           // preserve the values.
-                          unsigned int nalloc,  // /< Total number of elements to make available.
-                          psElemType type       // /< the datatype of the returned vector
+                          unsigned int nalloc,  ///< Total number of elements to make available.
+                          psElemType type       ///< the datatype of the returned vector
                          );
 
@@ -107 +107 @@
  */
 
-psVector *psVectorSort(psVector * restrict outVector,   // /< the output vector to recycle, or NULL if new
+psVector *psVectorSort(psVector * restrict outVector,   ///< the output vector to recycle, or NULL if new
                        // vector desired.
-                       const psVector * restrict inVector       // /< the vector to sort.
+                       const psVector * restrict inVector       ///< the vector to sort.
                       );