Changeset 9601 for trunk/psModules/src/camera/pmFPAUtils.h

Timestamp:

Oct 16, 2006, 5:03:35 PM (20 years ago)

Author:

Paul Price

Message:

Documenting pmFPAUtils.[ch]

File:

• trunk/psModules/src/camera/pmFPAUtils.h (modified) (2 diffs)

trunk/psModules/src/camera/pmFPAUtils.h

@@ +1 @@
+/// @file pmFPAUtils.h
+///
+/// @brief Utility functions for FPAs
+///
+/// @ingroup Camera
+///
+/// @author Paul Price, IfA
+///
+/// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-17 03:03:35 $
+///
+/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
+///
+
 #ifndef PM_FPA_UTILS_H
 #define PM_FPA_UTILS_H
@@ -4 +18 @@
 #include "pmFPA.h"
 
-// Find a chip by name; return the index
-int pmFPAFindChip(const pmFPA *fpa, // FPA in which to find the chip
-                  const char *name // Name of the chip
+/// Find a chip by name; return the index
+///
+/// Looks for a chip within the FPA with CHIP.NAME matching the provided name.  Returns the index of the chip,
+/// or -1 if it was not found.
+int pmFPAFindChip(const pmFPA *fpa,     ///< FPA in which to find the chip
+                  const char *name      ///< Name of the chip
                  );
 
-// Find a cell by name; return the index
-int pmChipFindCell(const pmChip *chip, // Chip in which to find the cell
-                   const char *name // Name of the cell
+/// Find a cell by name; return the index
+///
+/// Looks for a cell within the chip with CELL.NAME matching the provided name.  Returns the index of the
+/// cell, or -1 if it was not found.
+int pmChipFindCell(const pmChip *chip,  // Chip in which to find the cell
+                   const char *name     // Name of the cell
                   );