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

trunk/archive/pslib/include/psFFT.h

@@ -6 +6 @@
 /* Fourier Transform functions */
 
-/* Return Fourier Transform of an array */
+/** Return Fourier Transform of an array */
 psComplexArray *
-psRealFFT(psComplexArray *restrict out, // Output array to be returned; may be NULL
-          const psFloatArray *restrict myArray // Input array
+psRealFFT(psComplexArray *restrict out, //!< Output array to be returned; may be NULL
+          const psFloatArray *restrict myArray //!< Input array
           );
 
-/* Return [inverse?] Fourier Transform of a complex array */
-/* May NOT be done in-place (restrict-ed) */
+/** Return [inverse?] Fourier Transform of a complex array.  May NOT be done in-place (restrict-ed) */
 psComplexArray *
-psComplexFFT(psComplexArray *restrict out, // Output array to be returned; may be NULL
-             const psComplexArray *restrict myArray, // Input array
-             int sign                   // +1 or -1 to indicate direction of FT
+psComplexFFT(psComplexArray *restrict out, //!< Output array to be returned; may be NULL
+             const psComplexArray *restrict myArray, //!< Input array
+             int sign                   //!< +1 or -1 to indicate direction of FT
              );
 
-/* Return Power spectrum of a array */
+/** Return Power spectrum of a array */
 psFloatArray *
-psPowerSpec(psFloatArray *restrict out, // Output array to be returned
-            const psFloatArray *restrict myArray // Input array
+psPowerSpec(psFloatArray *restrict out, //!< Output array to be returned
+            const psFloatArray *restrict myArray //!< Input array
             );