Changeset 9718

Timestamp:

Oct 23, 2006, 3:05:55 PM (20 years ago)

Author:

Paul Price

Message:

Adding doxygen tags.

File:

• trunk/psModules/src/camera/pmFPAMosaic.h (modified) (3 diffs)

trunk/psModules/src/camera/pmFPAMosaic.h

@@ -7 +7 @@
 /// @author Paul Price, IfA
 ///
-/// @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
-/// @date $Date: 2006-10-17 02:35:52 $
+/// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-24 01:05:55 $
 ///
 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
@@ -24 +24 @@
 /// getting an image of the chip on the sky.  The mosaicking is done so as to avoid performing a deep copy of
 /// the pixels, if possible.
-bool pmChipMosaic(pmChip *target,       // Target chip --- may contain only a single cell
-                  const pmChip *source  // Source chip whose cells will be mosaicked
+bool pmChipMosaic(pmChip *target,       ///< Target chip --- may contain only a single cell
+                  const pmChip *source  ///< Source chip whose cells will be mosaicked
                  );
 
@@ -34 +34 @@
 /// CELL.X0 and CELL.Y0 offsets.  This is useful for getting an image of the FPA on the sky.  The mosaicking
 /// is done so as to avoid performing a deep copy of the pixels, if possible.
-bool pmFPAMosaic(pmFPA *target,         // Target FPA --- may contain only a single chip with a single cell
-                 const pmFPA *source    // FPA whose chips and cells will be mosaicked
+bool pmFPAMosaic(pmFPA *target,         ///< Target FPA --- may contain only a single chip with a single cell
+                 const pmFPA *source    ///< FPA whose chips and cells will be mosaicked
                 );