Changeset 153 for trunk/archive/pslib/include/psComplexArrays.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/psComplexArrays.h (modified) (1 diff)

trunk/archive/pslib/include/psComplexArrays.h

@@ -6 +6 @@
 /* Complex number arrays */
 
-/* Multiplication of two complex number arrays */
-/* Purposely leave these NOT restrict-ed, so that the multiplication may be done in-place */
+/** Multiplication of two complex number arrays.  Purposely leave these NOT restrict-ed, so that the
+ * multiplication may be done in-place
+ */
 psComplexArray *
-psComplexMultiply(psComplexArray *out, // Output array to be returned; may be NULL
-                  const psComplexArray *complex1, // Input complex array 1
-                  const psComplexArray *complex2 // Input complex array 2
+psComplexMultiply(psComplexArray *out, //!< Output array to be returned; may be NULL
+                  const psComplexArray *complex1, //!< Input complex array 1
+                  const psComplexArray *complex2 //!< Input complex array 2
                   );
 
-/* Division of two complex number arrays */
-/* Purposely leave these NOT restrict-ed, so that the division may be done in-place */
+/** Division of two complex number arrays.  Purposely leave these NOT restrict-ed, so that the division
+ * may be done in-place
+ */
 psComplexArray *
-psComplexDivide(psComplexArray *out,    // Output array to be returned; may be NULL
-                const psComplexArray *complex1, // Input complex array 1
-                const psComplexArray *complex2 // Input complex array 2
+psComplexDivide(psComplexArray *out,    //!< Output array to be returned; may be NULL
+                const psComplexArray *complex1, //!< Input complex array 1
+                const psComplexArray *complex2 //!< Input complex array 2
                 );
 
-/* Complex conjugates for a complex number array */
-/* Purposely leave these NOT restrict-ed, so that the operation may be done in-place */
+/** Complex conjugates for a complex number array. Purposely leave these NOT restrict-ed, so that the
+ * operation may be done in-place
+ */
 psComplexArray *
-psComplexConjugate(psComplexArray *out, // Output array to be returned; may be NULL
-                   const psComplexArray *myComplexNumbers // Input complex number array
+psComplexConjugate(psComplexArray *out, //!< Output array to be returned; may be NULL
+                   const psComplexArray *myComplexNumbers //!< Input complex number array
                    );
 
-/* Moduli for a complex number array */
+/** Moduli for a complex number array */
 psFloatArray *
-psComplexModulus(const psComplex *restrict myComplexNumbers // Input complex number array
+psComplexModulus(const psComplex *restrict myComplexNumbers //!< Input complex number array
                  );