Changeset 21409 for trunk/psastro/src/psastro.h

Timestamp:

Feb 6, 2009, 4:03:34 PM (17 years ago)

Author:

giebink

Message:

Added Doxygen tags

File:

• trunk/psastro/src/psastro.h (modified) (4 diffs)

trunk/psastro/src/psastro.h

@@ -1 @@
-/* This file defines the library functions available to external programs.  It must be included
- * by programs which are compiled against psphot functions.
+/** @file psastro.h
+ *
+ *  @brief This file defines the library functions available to external 
+ *  programs.  
+ *
+ *  It must be included by programs which are compiled against 
+ *  psphot functions.
+ *
+ *  @ingroup psastro
+ *
+ *  @author IfA
+ *  @version $Revision: 1.48 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-07 02:03:34 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
  */
 
@@ -7 +19 @@
 
 # include "psastroErrorCodes.h"
-# define PSASTRO_RECIPE "PSASTRO" // Name of the recipe to use
+
+/// @addtogroup psastro
+/// @{
+
+# define PSASTRO_RECIPE "PSASTRO" ///< Name of the recipe to use
 
 # define psMemCopy(A)(psMemIncrRefCounter((A)))
@@ -14 +30 @@
 # define SIGN(X)  (((X) == 0) ? 0 : ((fabs((double)(X))) / (X)))
 
-// this structure represents a fit to the logN / logS curve for a set of stars
-// logN = offset + slope * logS
+/**
+ * this structure represents a fit to the logN / logS curve for a set of stars
+ * logN = offset + slope * logS
+ */
 typedef struct {
-    double mMin;                        // minimum magnitude bin with data
-    double mMax;                        // maximum magnitude bin with data
-    double offset;                      // fitted line offset
-    double slope;                       // fitted line slope
-    double mPeak;                       // mag of peak bin
-    int nPeak;                          // # of stars in peak bin
-    int sPeak;                          // sum of stars to peak bin
+    double mMin;                        ///< minimum magnitude bin with data
+    double mMax;                        ///< maximum magnitude bin with data
+    double offset;                      ///< fitted line offset
+    double slope;                       ///< fitted line slope
+    double mPeak;                       ///< mag of peak bin
+    int nPeak;                          ///< # of stars in peak bin
+    int sPeak;                          ///< sum of stars to peak bin
 } pmLumFunc;
 
@@ -123 +141 @@
 bool psastroZeroPointFromRecipe (float *zeropt, float *exptime, pmFPA *fpa, psMetadata *recipe);
 
+///@}
 # endif /* PSASTRO_H */