Changeset 9592 for trunk/psModules/src/camera/pmFPAHeader.h

Timestamp:

Oct 16, 2006, 3:29:02 PM (20 years ago)

Author:

Paul Price

Message:

Documenting pmFPAHeader.[ch]

File:

• trunk/psModules/src/camera/pmFPAHeader.h (modified) (1 diff)

trunk/psModules/src/camera/pmFPAHeader.h

@@ +1 @@
+/// @file pmFPAHeader.h
+///
+/// @brief Functions read FITS headers for FPA components
+///
+/// @ingroup Camera
+///
+/// @author Paul Price, IfA
+///
+/// @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-17 01:29:02 $
+///
+/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
+///
+
 #ifndef PM_FPA_HEADER_H
 #define PM_FPA_HEADER_H
 
-bool pmCellReadHeader(pmCell *cell,     // Cell for which to read header
-                      psFits *fits      // FITS file handle
-                     );
-bool pmChipReadHeader(pmChip *chip,     // Chip for which to read header
-                      psFits *fits      // FITS file handle
-                     );
-bool pmFPAReadHeader(pmFPA *fpa,        // FPA for which to read header
-                     psFits *fits       // FITS file handle
+/// Read the FITS header (and ingest concepts) for an FPA, if it exists at this level
+///
+/// Returns false if there was a problem.  Returns true if it successfully read the header, or if the header
+/// was already there.  No iteration to lower levels is performed.
+bool pmFPAReadHeader(pmFPA *fpa,        ///< FPA for which to read header
+                     psFits *fits       ///< FITS file handle
                     );
 
+/// Read the FITS header (and ingest concepts) for a chip, if it exists at this level
+///
+/// Returns false if there was a problem.  Returns true if it successfully read the header, or if the header
+/// was already there.  No iteration to lower levels is performed.
+bool pmChipReadHeader(pmChip *chip,     ///< Chip for which to read header
+                      psFits *fits      ///< FITS file handle
+                     );
+
+/// Read the FITS header (and ingest concepts) for a cell, if it exists at this level
+///
+/// Returns false if there was a problem.  Returns true if it successfully read the header, or if the header
+/// was already there.  No iteration to lower levels is performed.
+bool pmCellReadHeader(pmCell *cell,     ///< Cell for which to read header
+                      psFits *fits      ///< FITS file handle
+                     );
+
 #endif