Changeset 21239 for branches/eam_branch_20081230/ppArith/src/ppArithArguments.c

Timestamp:

Jan 30, 2009, 12:00:45 PM (17 years ago)

Author:

giebink

Message:

Doxygen comments made consistent

File:

• branches/eam_branch_20081230/ppArith/src/ppArithArguments.c (modified) (8 diffs)

branches/eam_branch_20081230/ppArith/src/ppArithArguments.c

@@ -6 +6 @@
  *
  *  @author IfA
- *  @version $Revision: 1.4.30.1 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2009-01-30 01:38:25 $
+ *  @version $Revision: 1.4.30.2 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-01-30 22:00:45 $
  *  Copyright 2009 Institute for Astronomy, University of Hawaii
  */
@@ -22 +22 @@
 #include "ppArith.h"
 
-// Print usage information and die
-static void usage(const char *program,  // Name of the program
-                  psMetadata *arguments, // Command-line arguments
-                  pmConfig *config      // Configuration
+/**
+ * Print usage information and die
+ */
+static void usage(const char *program,  ///< Name of the program
+                  psMetadata *arguments, ///< Command-line arguments
+                  pmConfig *config      ///< Configuration
     )
 {
@@ -40 +42 @@
 }
 
-// Get a string value from the command-line and add it to the target
-static bool valueArgStr(psMetadata *arguments, // Command-line arguments
-                        const char *argName, // Argument name in the command-line arguments
-                        const char *mdName, // Name for value in the metadata
-                        psMetadata *target // Target metadata to which to add value
+/**
+ * Get a string value from the command-line and add it to the target
+ */
+static bool valueArgStr(psMetadata *arguments, ///< Command-line arguments
+                        const char *argName, ///< Argument name in the command-line arguments
+                        const char *mdName, ///< Name for value in the metadata
+                        psMetadata *target ///< Target metadata to which to add value
                         )
 {
-    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);
@@ -55 +59 @@
 
 /**
- * \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
-                     const char *comment, // Description of the file
-                     pmConfig *config // Configuration
+static void fileList(const char *file, ///< The symbolic name for the file
+                     const char *name, ///< The name of the file
+                     const char *comment, ///< Description of the file
+                     pmConfig *config ///< Configuration
     )
 {
-    psArray *files = psArrayAlloc(1); // Array with file names
+    psArray *files = psArrayAlloc(1); ///< Array with file names
     files->data[0] = psStringCopy(name);
     psMetadataAddArray(config->arguments, PS_LIST_TAIL, file, 0, comment, files);
@@ -75 +78 @@
     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);
@@ -88 +91 @@
     bool isMask = psMetadataLookupBool(NULL, arguments, "-mask"); // Are we dealing with masks?
     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 *inFilerule = isMask ? "PPARITH.INPUT.MASK" : "PPARITH.INPUT.IMAGE"; ///< Input 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);
@@ -95 +98 @@
                      "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.");
@@ -115 +118 @@
 
     // 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);