Changeset 257 for trunk/archive/pslib/include/psStats.h

Timestamp:

Mar 18, 2004, 9:37:58 PM (22 years ago)

Author:

eugene

Message:

code cleanup for Doxygen support & readability

File:

• trunk/archive/pslib/include/psStats.h (modified) (6 diffs)

trunk/archive/pslib/include/psStats.h

@@ -70 +70 @@
 
 
-/** Do Statistics on an array.  Returns a status value. */
+/** Do Statistics on an array.  Returns a status value. \ingroup MathGroup */
 psStats *
 psArrayStats(const psFloatArray *restrict myArray, //!< Array to be analysed
@@ -81 +81 @@
 /***********************************************************************************************************/
 
-/** Histograms */
+/** Histograms  */
 typedef struct {
     const psFloatArray *restrict lower; //!< Lower bounds for the bins
@@ -90 +90 @@
 } psHistogram;
 
-/** Constructor */
+/** Constructor \ingroup MathGroup */
 psHistogram *
 psHistogramAlloc(float lower,           //!< Lower limit for the bins
@@ -97 +97 @@
     );
 
-/** Generic constructor */
+/** Generic constructor \ingroup MathGroup */
 psHistogram *
 psHistogramAllocGeneric(const psFloatArray *restrict lower, //!< Lower bounds for the bins
@@ -105 +105 @@
     );
 
-/** Destructor */
+/** Destructor \ingroup MathGroup **/
 void
 psHistogramFree(psHistogram *restrict myHist //!< Histogram to destroy
@@ -111 +111 @@
 
 
-/** Calculate a histogram */
+/** Calculate a histogram \ingroup MathGroup **/
 psHistogram *
 psGetArrayHistogram(psHistogram *restrict myHist, //!< Histogram data