Changeset 21244 for trunk/ppMerge/src/ppMerge.c

Timestamp:

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

Author:

eugene

Message:

merging Doxygen templates added by Bill G

File:

• trunk/ppMerge/src/ppMerge.c (modified) (6 diffs)

trunk/ppMerge/src/ppMerge.c

@@ +1 @@
+/** @file ppMerge.c
+ *
+ *  @brief
+ *
+ *  @ingroup ppMerge
+ *
+ *  @author IfA
+ *  @version $Revision: 1.26 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-01 21:43:05 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
+ */
+
 #include "ppMerge.h"
 
@@ -12 +24 @@
     psTimerStart(TIMERNAME);
 
-    psExit exitValue = PS_EXIT_SUCCESS; // Exit value for program
+    psExit exitValue = PS_EXIT_SUCCESS; ///< Exit value for program
 
-    pmConfig *config = pmConfigRead(&argc, argv, PPMERGE_RECIPE); // Configuration
+    pmConfig *config = pmConfigRead(&argc, argv, PPMERGE_RECIPE); ///< Configuration
     if (!config) {
         psErrorStackPrint(stderr, "Error reading configuration.");
@@ -27 +39 @@
     }
 
-    ppMergeType type = psMetadataLookupS32(NULL, config->arguments, "TYPE"); // Type of frame
+    ppMergeType type = psMetadataLookupS32(NULL, config->arguments, "TYPE"); ///< Type of frame
     switch (type) {
       case PPMERGE_TYPE_MASK:
@@ -58 +70 @@
 
     // Output the statistics
-    bool mdok;                          // Status of MD lookup
-    psString statsName = psMetadataLookupStr(&mdok, config->arguments, "STATS.NAME"); // Statistics file name
+    bool mdok;                          ///< Status of MD lookup
+    psString statsName = psMetadataLookupStr(&mdok, config->arguments, "STATS.NAME"); ///< Statistics file name
     if (mdok && statsName && strlen(statsName) > 0) {
-        psString resolved = pmConfigConvertFilename(statsName, config, true, true); // Resolved filename
-        FILE *statsFile = fopen(resolved, "w"); // Output statistics file
+        psString resolved = pmConfigConvertFilename(statsName, config, true, true); ///< Resolved filename
+        FILE *statsFile = fopen(resolved, "w"); ///< Output statistics file
         if (!statsFile) {
             psError(PS_ERR_IO, true, "Unable to open statistics file %s for writing.", resolved);
@@ -70 +82 @@
         }
         psFree(resolved);
-        psMetadata *stats = psMetadataLookupMetadata(&mdok, config->arguments, "STATS.DATA"); // Statistics
+        psMetadata *stats = psMetadataLookupMetadata(&mdok, config->arguments, "STATS.DATA"); ///< Statistics
         if (!stats) {
             psError(PS_ERR_UNEXPECTED_NULL, false, "Unable to find statistics");
@@ -76 +88 @@
             goto die;
         }
-        psString statsOut = psMetadataConfigFormat(stats); // String to write out
+        psString statsOut = psMetadataConfigFormat(stats); ///< String to write out
         fprintf(statsFile, "%s", statsOut);
         psFree(statsOut);