Changeset 21323 for trunk/pswarp/src/pswarpSetMaskBits.c

Timestamp:

Feb 5, 2009, 10:44:04 AM (17 years ago)

Author:

eugene

Message:

merging Doxygen comments by Bill G from eam_branch_20081230

File:

• trunk/pswarp/src/pswarpSetMaskBits.c (modified) (1 diff)

trunk/pswarp/src/pswarpSetMaskBits.c

@@ +1 @@
+/** @file pswarpSetMaskBits.c
+ *
+ *  @brief
+ *
+ *  @ingroup pswarp
+ *
+ *  @author IfA
+ *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-05 20:44:04 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
+ */
+
 # include "pswarp.h"
 
-// This function is called by the stand-alone pswarp program to set the mask values in the
-// config file.  It sets the named mask values MASK.PSPHOT and MARK.PSPHOT in the PSPHOT
-// recipe.  Functions or programs which call psphotReadout as a library function must set these
-// named mask values in the PSPHOT recipe on their own.  This function should only be called
-// after the first header of the input mask image has been loaded and the named mask bits
-// updated in the config metadata.
-
+/** This function is called by the stand-alone pswarp program to set the mask values in the
+ * config file.  It sets the named mask values MASK.PSPHOT and MARK.PSPHOT in the PSPHOT
+ * recipe.  Functions or programs which call psphotReadout as a library function must set these
+ * named mask values in the PSPHOT recipe on their own.  This function should only be called
+ * after the first header of the input mask image has been loaded and the named mask bits
+ * updated in the config metadata.
+ */
 bool pswarpSetMaskBits (pmConfig *config) {
 
-    psImageMaskType maskIn = 0x00;                      // mask for the input image
-    psImageMaskType markIn = 0x00;                      // mark for the input image
-    psImageMaskType maskOut = 0x00;                     // mask for the output image
+    psImageMaskType maskIn = 0x00;                      ///< mask for the input image
+    psImageMaskType markIn = 0x00;                      ///< mark for the input image
+    psImageMaskType maskOut = 0x00;                     ///< mask for the output image
 
     // this function sets the required single-image mask bits