Changeset 9698 for trunk/psModules/src/camera/pmHDU.h

Timestamp:

Oct 20, 2006, 5:00:43 PM (20 years ago)

Author:

Paul Price

Message:

Adding more info to the descriptions.

File:

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

trunk/psModules/src/camera/pmHDU.h

@@ -7 +7 @@
 /// @author Paul Price, IfA
 ///
-/// @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
-/// @date $Date: 2006-10-17 03:35:58 $
+/// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-21 03:00:43 $
 ///
 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
@@ -34 +34 @@
 
 /// Allocator for pmHDU
-pmHDU *pmHDUAlloc(const char *extname);
+pmHDU *pmHDUAlloc(const char *extname   ///< Extension name, or NULL for PHU
+                 );
 
 /// Read the HDU header only
+///
+/// Moves to the appropriate extension
 bool pmHDUReadHeader(pmHDU *hdu,        ///< HDU for which to read header
                      psFits *fits       ///< FITS file from which to read
@@ -42 +45 @@
 
 /// Read the HDU header and pixels
+///
+/// Moves to the appropriate extension
 bool pmHDURead(pmHDU *hdu,              ///< HDU to read
                psFits *fits             ///< FITS file to read from