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

Timestamp:

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

Author:

giebink

Message:

Added Doxygen tags

File:

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

trunk/psastro/src/psastroModelBoresite.c

@@ +1 @@
+/** @file psastroModelBoresite.c
+ *
+ *  @brief
+ *
+ *  @ingroup psastroModel
+ *
+ *  @author IfA
+ *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-07 02:03:34 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
+ */
+
 # include "psastroStandAlone.h"
 
-// the full chisq is built of two associated sums over coordinates:
-// chisq = sum ((X_obs - X_fit(t))^2 + (Y_obs - Y_fit(t))^2)
-// we use split this into a 2x long vector and use coord[1] to distinguish the X and Y terms:
-// coord[0] = measured X or measured Y
-// coord[1] =          0 or          1
+/**
+ * the full chisq is built of two associated sums over coordinates:
+ * chisq = sum ((X_obs - X_fit(t))^2 + (Y_obs - Y_fit(t))^2)
+ * we use split this into a 2x long vector and use coord[1] to distinguish the X and Y terms:
+ * coord[0] = measured X or measured Y
+ * coord[1] =          0 or          1
+ */
 psF32 psastroModelBoresite (psVector *deriv, const psVector *params, const psVector *coord) {