Changeset 21229 for branches/eam_branch_20081230/ppArith/src/ppArithReadout.c

Timestamp:

Jan 29, 2009, 3:39:49 PM (17 years ago)

Author:

giebink

Message:

Doxygen place holders added

File:

• branches/eam_branch_20081230/ppArith/src/ppArithReadout.c (modified) (3 diffs)

branches/eam_branch_20081230/ppArith/src/ppArithReadout.c

@@ +1 @@
+/** @file ppArithReadout.c
+ *
+ *  @brief
+ *
+ *  @ingroup ppArith
+ *
+ *  @author IfA
+ *  @version $Revision: 1.2.32.2 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-01-30 01:39:32 $
+ *  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;