Changeset 153 for trunk/archive/pslib/include/psMatrix.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/psMatrix.h (modified) (2 diffs)

trunk/archive/pslib/include/psMatrix.h

@@ -2 +2 @@
 #define PS_MATRIX_H
 
-/* A matrix */
+/** A matrix */
 typedef struct {
-    int xSize, ySize;                   // Dimensions in x and y
-    float *restrict *restrict value;    // Values in matrix
+    int xSize, ySize;                   //!< Dimensions in x and y
+    float *restrict *restrict value;    //!< Values in matrix
 } psMatrix;
 
-/* Constructor */
+/** Constructor */
 psMatrix *
-psMatrixNew(int Xdimen,                 // x dimension of new matrix
-            int Ydimen                  // y dimension of new matrix
+psMatrixNew(int Xdimen,                 //!< x dimension of new matrix
+            int Ydimen                  //!< y dimension of new matrix
             );
 
-/* Destructor */
+/** Destructor */
 void
-psMatrixDel(psMatrix *restrict myMatrix // Matrix to destroy
+psMatrixDel(psMatrix *restrict myMatrix //!< Matrix to destroy
             );
 
@@ -23 +23 @@
 /* Linear Algebra */
 
-/* Invert matrix */
-/* Not using restrict, to allow inversion to be done in-place */
+/** Invert matrix.  Not using restrict, to allow inversion to be done in-place */
 psMatrix *
-psInvertMatrix(psMatrix *out,           // Matrix to return, or NULL
-               const psMatrix *myMatrix, // Matrix to be inverted
-               float *restrict determinant // Determinant to return, or NULL
+psInvertMatrix(psMatrix *out,           //!< Matrix to return, or NULL
+               const psMatrix *myMatrix, //!< Matrix to be inverted
+               float *restrict determinant //!< Determinant to return, or NULL
                );
 
-/* Matrix determinant */
+/** Matrix determinant */
 float
-psDeterminant(const psMatrix *restrict myMatrix // Matrix to get determinant for
+psDeterminant(const psMatrix *restrict myMatrix //!< Matrix to get determinant for
               );
 
-/* Matrix Multiplication */
-/* Not using restrict, to allow matrix1 == matrix2, and to do multiplication in-place */
+/** Matrix Multiplication.  Not using restrict, to allow matrix1 == matrix2, and to do multiplication
+ * in-place
+ */
 psMatrix
-psMatrixMultiply(psMatrix *out,         // Matrix to return, or NULL
-                 const psMatrix *matrix1, // Matrix 1
-                 const psMatrix *matrix2 // Matrix 2
+psMatrixMultiply(psMatrix *out,         //!< Matrix to return, or NULL
+                 const psMatrix *matrix1, //!< Matrix 1
+                 const psMatrix *matrix2 //!< Matrix 2
                  );