Changeset 21244 for trunk/ppArith/src/ppArithLoop.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/ppArithLoop.c (modified) (7 diffs)

trunk/ppArith/src/ppArithLoop.c

@@ +1 @@
+/** @file ppArithLoop.c
+ *
+ *  @brief
+ *
+ *  @ingroup ppArith
+ *
+ *  @author IfA
+ *  @version $Revision: 1.7 $ $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>
@@ -16 +28 @@
     PS_ASSERT_PTR_NON_NULL(config, false);
 
-    bool mdok;                          // Status of MD lookup
-    const char *statsName = psMetadataLookupStr(&mdok, config->arguments, "STATS"); // Filename for statistics
-    psMetadata *stats = NULL;           // Container for statistics
-    FILE *statsFile = NULL;             // File stream for statistics
+    bool mdok;                          ///< Status of MD lookup
+    const char *statsName = psMetadataLookupStr(&mdok, config->arguments, "STATS"); ///< Filename for statistics
+    psMetadata *stats = NULL;           ///< Container for statistics
+    FILE *statsFile = NULL;             ///< File stream for statistics
     if (statsName && strlen(statsName) > 0) {
-        psString resolved = pmConfigConvertFilename(statsName, config, true, true); // Resolved filename
+        psString resolved = pmConfigConvertFilename(statsName, config, true, true); ///< Resolved filename
         statsFile = fopen(resolved, "w");
         if (!statsFile) {
@@ -33 +45 @@
     }
 
-    const char *outName = psMetadataLookupStr(NULL, config->arguments, "FILERULE.OUTPUT"); // Output filerule
-    pmFPAfile *output = psMetadataLookupPtr(NULL, config->files, outName); // Output file
+    const char *outName = psMetadataLookupStr(NULL, config->arguments, "FILERULE.OUTPUT"); ///< Output filerule
+    pmFPAfile *output = psMetadataLookupPtr(NULL, config->files, outName); ///< Output file
     assert(output);                     // We added it earlier
 
-    const char *inName = psMetadataLookupStr(NULL, config->arguments, "FILERULE.INPUT"); // Input filerule
-    pmFPAfile *input1 = NULL, *input2 = NULL; // Input files
-    psString fileRegex = NULL;          // Regular expression to find input files
+    const char *inName = psMetadataLookupStr(NULL, config->arguments, "FILERULE.INPUT"); ///< Input filerule
+    pmFPAfile *input1 = NULL, *input2 = NULL; ///< Input files
+    psString fileRegex = NULL;   ///< Regular expression to find input files
     psStringAppend(&fileRegex, "^%s$", inName);
-    psMetadataIterator *iter = psMetadataIteratorAlloc(config->files, PS_LIST_HEAD, fileRegex); // Iterator
-    psMetadataItem *item = psMetadataGetAndIncrement(iter); // Item from iteration
+    psMetadataIterator *iter = psMetadataIteratorAlloc(config->files, PS_LIST_HEAD, fileRegex); ///< Iterator
+    psMetadataItem *item = psMetadataGetAndIncrement(iter); ///< Item from iteration
     input1 = item->data.V;
     assert(input1);                     // It should be there!
@@ -51 +63 @@
     psFree(iter);
 
-    pmFPAview *view = pmFPAviewAlloc(0); // Pointer into FPA hierarchy
-    pmHDU *lastHDU = NULL;              // Last HDU that was updated
+    pmFPAview *view = pmFPAviewAlloc(0); ///< Pointer into FPA hierarchy
+    pmHDU *lastHDU = NULL;              ///< Last HDU that was updated
 
     // Iterate over the FPA hierarchy
@@ -59 +71 @@
     }
 
-    pmChip *outChip;                    // Output chip of interest
+    pmChip *outChip;                    ///< Output chip of interest
     while ((outChip = pmFPAviewNextChip(view, output->fpa, 1)) != NULL) {
-        pmChip *inChip1 = pmFPAviewThisChip(view, input1->fpa); // Input chip of interest
-        pmChip *inChip2 = input2 ? pmFPAviewThisChip(view, input2->fpa) : NULL; // Input chip of interest
+        pmChip *inChip1 = pmFPAviewThisChip(view, input1->fpa); ///< Input chip of interest
+        pmChip *inChip2 = input2 ? pmFPAviewThisChip(view, input2->fpa) : NULL; ///< Input chip of interest
         if (inChip2 && ((!inChip1->file_exists && inChip2->file_exists) ||
                         (inChip1->file_exists && !inChip2->file_exists))) {
@@ -78 +90 @@
         }
 
-        pmCell *outCell;                // Cell of interest
+        pmCell *outCell;                ///< Cell of interest
         while ((outCell = pmFPAviewNextCell(view, output->fpa, 1)) != NULL) {
-            pmCell *inCell1 = pmFPAviewThisCell(view, input1->fpa); // Input cell of interest
-            pmCell *inCell2 = input2 ? pmFPAviewThisCell(view, input2->fpa) : NULL; // Input cell of interest
+            pmCell *inCell1 = pmFPAviewThisCell(view, input1->fpa); ///< Input cell of interest
+            pmCell *inCell2 = input2 ? pmFPAviewThisCell(view, input2->fpa) : NULL; ///< Input cell of interest
             if (inCell2 && ((!inCell1->file_exists && inCell2->file_exists) ||
                             (inCell1->file_exists && !inCell2->file_exists))) {
@@ -105 +117 @@
             }
 
-            pmReadout *outRO;           // Readout of interest
+            pmReadout *outRO;           ///< Readout of interest
             while ((outRO = pmFPAviewNextReadout(view, output->fpa, 1))) {
                 if (!pmFPAfileIOChecks(config, view, PM_FPA_BEFORE)) {
                     return false;
                 }
-                pmReadout *inRO1 = pmFPAviewThisReadout(view, input1->fpa);// Input readout of interest
+                pmReadout *inRO1 = pmFPAviewThisReadout(view, input1->fpa);///< Input readout of interest
                 pmReadout *inRO2 = input2 ? pmFPAviewThisReadout(view, input2->fpa) :
-                    NULL;// Input readout of interest
+                    NULL;///< Input readout of interest
 
                 if (inRO2 && ((!inRO1->data_exists && inRO2->data_exists) ||