Changeset 21244 for trunk/ppArith/src/ppArithReadout.c

Timestamp:

Feb 1, 2009, 11:43:05 AM (17 years ago)

Author:

eugene

Message:

merging Doxygen templates added by Bill G

File:

• trunk/ppArith/src/ppArithReadout.c (modified) (4 diffs)

trunk/ppArith/src/ppArithReadout.c

@@ +1 @@
+/** @file ppArithReadout.c
+ *
+ *  @brief
+ *
+ *  @ingroup ppArith
+ *
+ *  @author IfA
+ *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-01 21:40:52 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
+ */
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
@@ -17 +29 @@
     PS_ASSERT_PTR_NON_NULL(view, false);
 
-    bool mdok;                          // Status of MD lookup
+    bool mdok;                          ///< Status of MD lookup
     bool isMask = psMetadataLookupBool(&mdok, config->arguments, "MASK");
 
-    psImage *inImage1;  // Input image 1
-    psImage *outImage;  // Output image
+    psImage *inImage1;  ///< Input image 1
+    psImage *outImage;  ///< Output image
     if (isMask) {
         inImage1 = input1->mask;
@@ -42 +54 @@
     PS_ASSERT_IMAGE_NON_NULL(inImage1, false);
 
-    psImage *inImage2 = NULL;           // Input image 2
+    psImage *inImage2 = NULL;           ///< Input image 2
     if (input2) {
         inImage2 = isMask ? input2->mask : input2->image;
@@ -61 +73 @@
 
     // Look up appropriate values
-    const char *op = psMetadataLookupStr(NULL, config->arguments, "OPERATION"); // Operation to perform
+    const char *op = psMetadataLookupStr(NULL, config->arguments, "OPERATION"); ///< Operation to perform
 
     if (input2) {