Changeset 4293 for trunk/psLib/src/collections/psPixels.h

Timestamp:

Jun 16, 2005, 2:11:08 PM (21 years ago)

Author:

drobbin

Message:

* empty log message *

File:

• trunk/psLib/src/collections/psPixels.h (modified) (4 diffs)

trunk/psLib/src/collections/psPixels.h

@@ -7 +7 @@
  *  @author Robert DeSonia, MHPCC
  *
- *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-11 02:19:05 $
+ *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-17 00:11:02 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -21 +21 @@
 /// @{
 
+/** Data structure for storing psPixel coordinates  */
 typedef struct
 {
-    psS32 x;
-    psS32 y;
+    psS32 x;                           ///< x coordinate
+    psS32 y;                           ///< y coordinate
 }
 psPixelCoord;
@@ -32 +33 @@
  *  Usually an image mask is the best way to carry information about what
  *  pixels mean what. However, in the case where the number of pixels in which
- *  we are interested is limited, it is more efficient to simply carry a list
+ *  we are interested is limited, it is more efficient to simply carry a list
  *  of pixels. An example of this is in the image combination code, where we
  *  want to perform an operation on a relatively small fraction of pixels, and
- *  it is inefficient to go through an entire mask image checking each pixel.
+ *  it is inefficient to go through an entire mask image checking each pixel.
  *
  */
 typedef struct
 {
-    int n;
-    int nalloc;
-    psPixelCoord* data;
+    int n;                             ///< Number in usa
+    int nalloc;                        ///< Number allocated
+    psPixelCoord* data;                ///< The pixel coordinates
 }
 psPixels;
@@ -136 +137 @@
 );
 
-/** Prints a psPixels to specified destination. */
+/** Prints a psPixels to specified destination.
+ *  
+ *  @return bool:    True if successful.
+*/
 bool p_psPixelsPrint(
-    FILE *fd,
-    psPixels* pixels,
-    const char *name
+    FILE *fd,                          ///< destination file descriptor
+    psPixels* pixels,                  ///< psPixels to print
+    const char *name                   ///< printf-style format of header line
 );