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

trunk/archive/pslib/include/psFunctions.h

@@ -6 +6 @@
 /* Standard Functions */
 
-/* Gaussian */
-/* Note that this is not a Gaussian deviate */
+/** Gaussian.  Note that this is not a Gaussian deviate */
 float
-psGaussian(float x,                     // Value at which to evaluate
-           float mean,                  // Mean for the Gaussian
-           float stddev                 // Standard deviation for the Gaussian
+psGaussian(float x,                     //!< Value at which to evaluate
+           float mean,                  //!< Mean for the Gaussian
+           float stddev                 //!< Standard deviation for the Gaussian
            );
 
-/* Polynomial: one dimension */
+/** Polynomial: one dimension */
 float
-psPolynomial1d(float x,                 // Value at which to evaluate
-               const psFloatArray *restrict coeffs // Coefficients for the polynomial
+psPolynomial1d(float x,                 //!< Value at which to evaluate
+               const psFloatArray *restrict coeffs //!< Coefficients for the polynomial
                );
 
-/* Polynomial: two dimensions */
+/** Polynomial: two dimensions */
 float
-psPolynomial2d(float x,                 // Value x at which to evaluate
-               float y,                 // Value y at which to evaluate
-               int orderx,              // Polynomial order in x
-               int ordery,              // Polynomial order in y
-               const psFloatArray *coeffs // Coefficients for the polynomial
+psPolynomial2d(float x,                 //!< Value x at which to evaluate
+               float y,                 //!< Value y at which to evaluate
+               int orderx,              //!< Polynomial order in x
+               int ordery,              //!< Polynomial order in y
+               const psFloatArray *coeffs //!< Coefficients for the polynomial
                );