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

Timestamp:

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

Author:

giebink

Message:

Added Doxygen tags

File:

• trunk/psastro/src/psastroMaskUpdates.c (modified) (6 diffs)

trunk/psastro/src/psastroMaskUpdates.c

@@ +1 @@
+/** @file psastroMaskUpdates.c
+ *
+ *  @brief 
+ *
+ *  @ingroup libpsastro
+ *
+ *  @author IfA
+ *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-07 02:03:34 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
+ */
+
 # include "psastroInternal.h"
 
@@ -17 +29 @@
 void psastroMaskRectangle (psImage *mask, psImageMaskType value, int x0, int y0, int x1, int y1);
 
-// create a mask or mask regions based on the collection of reference stars that are
-// in the vicinity of each chip
+/**
+ * create a mask or mask regions based on the collection of reference stars that * are in the vicinity of each chip
+ */
 bool psastroMaskUpdates (pmConfig *config) {
 
@@ -327 +340 @@
 }
 
-// convert chip coords to cell coords, given known cell
+/**
+ * convert chip coords to cell coords, given known cell
+ */
 bool pmCellCoordsForChip (float *xCell, float *yCell, pmCell *cell, float xChip, float yChip) {
 
@@ -351 +366 @@
 }
 
-// convert chip coords to cell coords, given known cell
+/**
+ * convert chip coords to cell coords, given known cell
+ */
 bool pmChipCoordsForCell (float *xChip, float *yChip, pmCell *cell, float xCell, float yCell) {
 
@@ -412 +429 @@
 }
 
-// identify the quadrant and draw the correct line
+/**
+ * identify the quadrant and draw the correct line
+ */
 void psastroMaskLine (psImage *mask, psImageMaskType value, double x1, double y1, double x2, double y2, int dW) {
 
@@ -440 +459 @@
 }
 
-// use the Bresenham line drawing technique
-// integer-only Bresenham line-draw version which is fast
+/**
+ * use the Bresenham line drawing technique
+ * integer-only Bresenham line-draw version which is fast
+ */
 void psastroMaskLineBresen (psImage *mask, psImageMaskType value, int X1, int Y1, int X2, int Y2, int dW, int swapcoords) {