Changeset 9608 for trunk/psModules/src/camera/pmHDUUtils.c

Timestamp:

Oct 16, 2006, 5:42:55 PM (20 years ago)

Author:

Paul Price

Message:

Documenting pmHDUUtils.[ch]

File:

• trunk/psModules/src/camera/pmHDUUtils.c (modified) (7 diffs)

trunk/psModules/src/camera/pmHDUUtils.c

@@ -9 +9 @@
 
 
-pmHDU *pmHDUFromFPA(const pmFPA *fpa    // FPA for which to find HDU
-                   )
+pmHDU *pmHDUFromFPA(const pmFPA *fpa)
 {
     PS_ASSERT_PTR_NON_NULL(fpa, NULL);
@@ -16 +15 @@
 }
 
-pmHDU *pmHDUFromChip(const pmChip *chip // Chip for which to find HDU
-                    )
+pmHDU *pmHDUFromChip(const pmChip *chip)
 {
     PS_ASSERT_PTR_NON_NULL(chip, NULL);
@@ -29 +27 @@
 }
 
-pmHDU *pmHDUFromCell(const pmCell *cell // Cell for which to find HDU
-                    )
+pmHDU *pmHDUFromCell(const pmCell *cell)
 {
     PS_ASSERT_PTR_NON_NULL(cell, NULL);
@@ -42 +39 @@
 }
 
-pmHDU *pmHDUFromReadout(const pmReadout *readout // Readout for which to find HDU
-                       )
+pmHDU *pmHDUFromReadout(const pmReadout *readout)
 {
     PS_ASSERT_PTR_NON_NULL(readout, NULL);
@@ -53 +49 @@
 
 // Get the lowest HDU
-pmHDU *pmHDUGetLowest(const pmFPA *fpa, // The FPA
-                      const pmChip *chip, // The chip, or NULL
-                      const pmCell *cell // The cell, or NULL
-                     )
+pmHDU *pmHDUGetLowest(const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 {
     pmHDU *hdu = NULL;          // The HDU that's at the lowest level
@@ -71 +64 @@
 
 // Get the highest HDU
-pmHDU *pmHDUGetHighest(const pmFPA *fpa, // The FPA
-                       const pmChip *chip, // The chip, or NULL
-                       const pmCell *cell // The cell, or NULL
-                      )
+pmHDU *pmHDUGetHighest(const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 {
     pmHDU *hdu = NULL;          // The HDU that's at the highest level
@@ -90 +80 @@
 }
 
-void pmHDUPrint(FILE *fd,               // File descriptor to which to print
-                const pmHDU *hdu,       // HDU to print
-                int level,              // Level at which to print
-                bool header             // Print header?
-               )
+void pmHDUPrint(FILE *fd, const pmHDU *hdu, int level, bool header)
 {
     PS_ASSERT_PTR_NON_NULL(hdu,);