Changeset 21268 for branches/eam_branch_20081230/pswarp/src/pswarpDefineSkycell.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/pswarpDefineSkycell.c (modified) (2 diffs)

branches/eam_branch_20081230/pswarp/src/pswarpDefineSkycell.c

@@ +1 @@
+/** @file pswarpDefineSkycell.c
+ *
+ *  @brief
+ *
+ *  @ingroup pswarp
+ *
+ *  @author IfA
+ *  @version $Revision: 1.10.6.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"
 
-// XXX this function is based on pmFPAfileDefineFromArgs
-// a skycell consists of only one file
+/**
+ * \brief XXX this function is based on pmFPAfileDefineFromArgs
+ * a skycell consists of only one file
 
-// search for argname on the config->argument list
-// construct an FPA based on the files in this list (must represent a single FPA)
-// built the association between the FPA elements (CHIP/CELL) and the files
-// define the pmFPAfile filename and bind it to this FPA
-// save the pmFPAfile on config->files
-// return the pmFPAfile (a view to the one saved on config->files)
+ * search for argname on the config->argument list and construct
+ * an FPA based on the files in this list (must represent a single FPA)
+ * built the association between the FPA elements (CHIP/CELL) and the files
+ * define the pmFPAfile filename and bind it to this FPA
+ * save the pmFPAfile on config->files
+ * @return the pmFPAfile (a view to the one saved on config->files)
+ */
 bool pswarpDefineSkycell (pmFPAfile **outFile, pmConfig **outConfig, pmConfig *config, const char *filename, const char *argname)
 {
@@ -59 +73 @@
     psFitsClose(fits);
 
-    // XXX format needs to be equivalent to SIMPLE
-    // determine the current format from the header
-    // determine camera if not specified already
+    // We need to force the format for the skycell to be equivalent to SIMPLE.  Determine
+    // the current format from the header; Determine camera if not specified already
     // XXX EAM : this operation should be defined as a pmConfig function (pmConfigCopy?)
-    skyConfig = pmConfigAlloc(0, NULL);
+    skyConfig = pmConfigAlloc();
     skyConfig->user = psMemIncrRefCounter(config->user);
     skyConfig->system = psMemIncrRefCounter(config->system);