Changeset 21268 for branches/eam_branch_20081230/pswarp/src/pswarpArguments.c

Timestamp:

Feb 2, 2009, 11:57:10 AM (17 years ago)

Author:

giebink

Message:

Doxygen comments added

File:

• branches/eam_branch_20081230/pswarp/src/pswarpArguments.c (modified) (8 diffs)

branches/eam_branch_20081230/pswarp/src/pswarpArguments.c

@@ +1 @@
+/** @file pswarpArguments.c
+ *
+ *  @brief
+ *
+ *  @ingroup pswarp
+ *
+ *  @author IfA
+ *  @version $Revision: 1.22.8.1 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-02 21:57:10 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
+ */
+
 # include "pswarp.h"
 # include <glob.h>
@@ -26 +38 @@
 
     {
-        int arg;                        // Argument Number
+        int arg;                        ///< Argument Number
         if ((arg = psArgumentGet(argc, argv, "-psphot-visual"))) {
             psArgumentRemove(arg, &argc, argv);
@@ -105 +117 @@
 }
 
-// Parse the recipe and format into the arguments
+/**
+ * Parse the recipe and format into the arguments
+ */
 bool pswarpOptions(pmConfig *config)
 {
@@ -116 +130 @@
 
     // Get grid size
-    bool status;                        // Status of MD lookup
+    bool status;                        ///< Status of MD lookup
     int nGridX = psMetadataLookupS32(&status, recipe, "GRID.NX");
     if (!status || nGridX <= 0) {
@@ -129 +143 @@
 
     // Get interpolation mode
-    const char *name = psMetadataLookupStr (&status, recipe, "INTERPOLATION.MODE"); // Name of interp mode
+    const char *name = psMetadataLookupStr (&status, recipe, "INTERPOLATION.MODE"); ///< Name of interp mode
     if (!name) {
         name = "BILINEAR";
         psLogMsg("pswarp", 3, "defaulting to %s interpolation", name);
     }
-    psImageInterpolateMode interpolationMode = psImageInterpolateModeFromString(name); // Mode for interp.
+    psImageInterpolateMode interpolationMode = psImageInterpolateModeFromString(name); ///< Mode for interp.
     if (interpolationMode == PS_INTERPOLATE_NONE) {
         interpolationMode = PS_INTERPOLATE_BILINEAR;
@@ -148 +162 @@
     }
 
-    float poorFrac = psMetadataLookupF32(&status, recipe, "POOR.FRAC"); // Frac of bad flux for a "poor"
+    float poorFrac = psMetadataLookupF32(&status, recipe, "POOR.FRAC"); ///< Frac of bad flux for a "poor"
     if (!status) {
         poorFrac = 0.0;
@@ -154 +168 @@
     }
 
-    float acceptFrac = psMetadataLookupF32(&status, recipe, "ACCEPT.FRAC"); // Min fraction of good pixels
+    float acceptFrac = psMetadataLookupF32(&status, recipe, "ACCEPT.FRAC"); ///< Min fraction of good pixels
     if (!status) {
         acceptFrac = 0.0;
@@ -194 +208 @@
     if (dump_file) {
         const char *skyCamera = psMetadataLookupStr(NULL, config->arguments,
-                                                    "SKYCELL.CAMERA");  // Name of camera for skycell
+                                                    "SKYCELL.CAMERA");  ///< Name of camera for skycell
         pmConfigCamerasCull(config, skyCamera);
         pmConfigRecipesCull(config, "PSWARP,PPSTATS,PSPHOT,MASKS");