IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Feb 6, 2009, 9:45:30 AM (17 years ago)
Author:
giebink
Message:

inline Doxygen comments deleted

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/ppArith/src/ppArithArguments.c

    r21244 r21378  
    66 *
    77 *  @author IfA
    8  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    9  *  @date $Date: 2009-02-01 21:40:52 $
     8 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2009-02-06 19:45:30 $
    1010 *  Copyright 2009 Institute for Astronomy, University of Hawaii
    1111 */
     
    2525 * Print usage information and die
    2626 */
    27 static void usage(const char *program,  ///< Name of the program
    28                   psMetadata *arguments, ///< Command-line arguments
    29                   pmConfig *config      ///< Configuration
     27static void usage(const char *program,  // Name of the program
     28                  psMetadata *arguments, // Command-line arguments
     29                  pmConfig *config      // Configuration
    3030    )
    3131{
     
    4545 * Get a string value from the command-line and add it to the target
    4646 */
    47 static bool valueArgStr(psMetadata *arguments, ///< Command-line arguments
    48                         const char *argName, ///< Argument name in the command-line arguments
    49                         const char *mdName, ///< Name for value in the metadata
    50                         psMetadata *target ///< Target metadata to which to add value
     47static bool valueArgStr(psMetadata *arguments, // Command-line arguments
     48                        const char *argName, // Argument name in the command-line arguments
     49                        const char *mdName, // Name for value in the metadata
     50                        psMetadata *target // Target metadata to which to add value
    5151                        )
    5252{
    53     psString value = psMetadataLookupStr(NULL, arguments, argName); ///< Value of interest
     53    psString value = psMetadataLookupStr(NULL, arguments, argName); // Value of interest
    5454    if (value && strlen(value) > 0) {
    5555        return psMetadataAddStr(target, PS_LIST_TAIL, mdName, 0, NULL, value);
     
    6161 * Add a single filename to the arguments as an array, so that it can be used with pmFPAfileBindFromArgs, etc
    6262 */
    63 static void fileList(const char *file, ///< The symbolic name for the file
    64                      const char *name, ///< The name of the file
    65                      const char *comment, ///< Description of the file
    66                      pmConfig *config ///< Configuration
     63static void fileList(const char *file, // The symbolic name for the file
     64                     const char *name, // The name of the file
     65                     const char *comment, // Description of the file
     66                     pmConfig *config // Configuration
    6767    )
    6868{
    69     psArray *files = psArrayAlloc(1); ///< Array with file names
     69    psArray *files = psArrayAlloc(1); // Array with file names
    7070    files->data[0] = psStringCopy(name);
    7171    psMetadataAddArray(config->arguments, PS_LIST_TAIL, file, 0, comment, files);
     
    7878    assert(config);
    7979
    80     psMetadata *arguments = psMetadataAlloc(); ///< Command-line arguments
     80    psMetadata *arguments = psMetadataAlloc(); // Command-line arguments
    8181    psMetadataAddStr(arguments, PS_LIST_TAIL, "-file1", 0, "First image", NULL);
    8282    psMetadataAddStr(arguments, PS_LIST_TAIL, "-op", 0, "Operation to perform", NULL);
     
    9292    psMetadataAddBool(config->arguments, PS_LIST_TAIL, "MASK", 0, "Produce a mask image?", isMask);
    9393    const char *inFilerule = isMask ? "PPARITH.INPUT.MASK" : "PPARITH.INPUT.IMAGE"; ///< Input file rule
    94     const char *outFilerule = isMask ? "PPARITH.OUTPUT.MASK" : "PPARITH.OUTPUT.IMAGE"; ///< Output file rule
     94    const char *outFilerule = isMask ? "PPARITH.OUTPUT.MASK" : "PPARITH.OUTPUT.IMAGE"; // Output file rule
    9595    psMetadataAddStr(config->arguments, PS_LIST_TAIL, "FILERULE.INPUT", 0,
    9696                     "File rule for input", inFilerule);
     
    9898                     "File rule for output", outFilerule);
    9999
    100     bool status = false;                ///< Status for file definition
     100    bool status = false;                // Status for file definition
    101101
    102102    // First file
    103     const char *name1 = psMetadataLookupStr(NULL, arguments, "-file1"); ///< Name of first image
     103    const char *name1 = psMetadataLookupStr(NULL, arguments, "-file1"); // Name of first image
    104104    if (!name1 || strlen(name1) == 0) {
    105105        psError(PS_ERR_UNEXPECTED_NULL, true, "No input image specified.");
     
    118118
    119119    // Second file is optional (won't be one for unary operations)
    120     const char *name2 = psMetadataLookupStr(NULL, arguments, "-file2"); ///< Name of second image
     120    const char *name2 = psMetadataLookupStr(NULL, arguments, "-file2"); // Name of second image
    121121    if (name2 && strlen(name2) > 0) {
    122122        fileList("INPUT2", name2, "Name of the second input image", config);
Note: See TracChangeset for help on using the changeset viewer.