Changeset 21229 for branches/eam_branch_20081230/ppArith/src/ppArithArguments.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/ppArithArguments.c (modified) (7 diffs)

branches/eam_branch_20081230/ppArith/src/ppArithArguments.c

@@ +1 @@
+/** @file ppArithArguments.c
+ *
+ *  @brief
+ *
+ *  @ingroup ppArith
+ *
+ *  @author IfA
+ *  @version $Revision: 1.4.30.1 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-01-30 01:38:25 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
+ */
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
@@ -35 +47 @@
                         )
 {
-    psString value = psMetadataLookupStr(NULL, arguments, argName); // Value of interest
+    psString value = psMetadataLookupStr(NULL, arguments, argName); /** Value of interest */
     if (value && strlen(value) > 0) {
         return psMetadataAddStr(target, PS_LIST_TAIL, mdName, 0, NULL, value);
@@ -42 +54 @@
 }
 
-// Add a single filename to the arguments as an array, so that it can be used with pmFPAfileBindFromArgs, etc
+/**
+ * \fn fileList
+ * Add a single filename to the arguments as an array, so that it can be used with pmFPAfileBindFromArgs, etc
+ */
 static void fileList(const char *file, // The symbolic name for the file
                      const char *name, // The name of the file
@@ -60 +75 @@
     assert(config);
 
-    psMetadata *arguments = psMetadataAlloc(); // Command-line arguments
+    psMetadata *arguments = psMetadataAlloc(); /** Command-line arguments */
     psMetadataAddStr(arguments, PS_LIST_TAIL, "-file1", 0, "First image", NULL);
     psMetadataAddStr(arguments, PS_LIST_TAIL, "-op", 0, "Operation to perform", NULL);
@@ -74 +89 @@
     psMetadataAddBool(config->arguments, PS_LIST_TAIL, "MASK", 0, "Produce a mask image?", isMask);
     const char *inFilerule = isMask ? "PPARITH.INPUT.MASK" : "PPARITH.INPUT.IMAGE"; // Input file rule
-    const char *outFilerule = isMask ? "PPARITH.OUTPUT.MASK" : "PPARITH.OUTPUT.IMAGE"; // Output file rule
+    const char *outFilerule = isMask ? "PPARITH.OUTPUT.MASK" : "PPARITH.OUTPUT.IMAGE"; /** Output file rule */
     psMetadataAddStr(config->arguments, PS_LIST_TAIL, "FILERULE.INPUT", 0,
                      "File rule for input", inFilerule);
@@ -80 +95 @@
                      "File rule for output", outFilerule);
 
-    bool status = false;                // Status for file definition
+    bool status = false;                /** Status for file definition */
 
     // First file
-    const char *name1 = psMetadataLookupStr(NULL, arguments, "-file1"); // Name of first image
+    const char *name1 = psMetadataLookupStr(NULL, arguments, "-file1"); /** Name of first image */
     if (!name1 || strlen(name1) == 0) {
         psError(PS_ERR_UNEXPECTED_NULL, true, "No input image specified.");
@@ -100 +115 @@
 
     // Second file is optional (won't be one for unary operations)
-    const char *name2 = psMetadataLookupStr(NULL, arguments, "-file2"); // Name of second image
+    const char *name2 = psMetadataLookupStr(NULL, arguments, "-file2"); /** Name of second image */
     if (name2 && strlen(name2) > 0) {
         fileList("INPUT2", name2, "Name of the second input image", config);