Changeset 21323 for trunk/pswarp/src/pswarpDefineSkycell.c

Timestamp:

Feb 5, 2009, 10:44:04 AM (17 years ago)

Author:

eugene

Message:

merging Doxygen comments by Bill G from eam_branch_20081230

File:

• trunk/pswarp/src/pswarpDefineSkycell.c (modified) (1 diff)

trunk/pswarp/src/pswarpDefineSkycell.c

@@ +1 @@
+/** @file pswarpDefineSkycell.c
+ *
+ *  @brief
+ *
+ *  @ingroup pswarp
+ *
+ *  @author IfA
+ *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-05 20:44:04 $
+ *  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)
 {