Changeset 21409 for trunk/psastro/src/psastroAstromGuess.c

Timestamp:

Feb 6, 2009, 4:03:34 PM (17 years ago)

Author:

giebink

Message:

Added Doxygen tags

File:

• trunk/psastro/src/psastroAstromGuess.c (modified) (1 diff)

trunk/psastro/src/psastroAstromGuess.c

@@ +1 @@
+/** @file psastroAstromGuess.c
+ *
+ *  @brief 
+ *
+ *  @ingroup libpsastro
+ *
+ *  @author IfA
+ *  @version $Revision: 1.34 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-07 02:03:34 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
+ */
+
 # include "psastroInternal.h"
 # define DEBUG 0
 
-// this function loads the header WCS astrometry terms into the fpa terms and applies the
-// astrometry to the detected objects.
-
-// this function assumes the initial astrometry arrives in the form of WCS keywords in the
-// headers corresponding to the chips.
-
+/**
+ * \brief This function loads the header WCS astrometry terms into the fpa 
+ * terms and applies the astrometry to the detected objects.
+ * 
+ * This function assumes the initial astrometry arrives in the form of WCS 
+ * keywords in the headers corresponding to the chips.
+ */
 bool psastroAstromGuess (int *nStars, pmConfig *config) {