Changeset 257 for trunk/archive/pslib/include/psImage.h

Timestamp:

Mar 18, 2004, 9:37:58 PM (22 years ago)

Author:

eugene

Message:

code cleanup for Doxygen support & readability

File:

• trunk/archive/pslib/include/psImage.h (modified) (4 diffs)

trunk/archive/pslib/include/psImage.h

@@ -5 +5 @@
  *  \brief Basic image definitions and operations.
  *  \ingroup AstroGroup
- */
-
-/** General image manipulation functions.
- *  These functions operate on individual 2D images
  */
 
@@ -32 +28 @@
 } psImage;
 
+/** Functions **************************************************************/
+/** \addtogroup AstroGroup Astronomy-Specific Utilities
+ *  \{
+ */
+
 /*** Image structure manipulation ***/
+
 /// Create an image of the specified size and type.
-typedef int PS_IMAGE_DEPTH;             // RHL Added this to make the psImage compile XXX
-
 psImage *
 psImageAlloc (int nx,                   ///< image width 
               int ny,                   ///< image height 
-              PS_IMAGE_DEPTH depth      ///< image depth 
-    );
+              psType type)              ///< image data type 
+;
 
 /// Create a subimage of the specified area.
@@ -68 +68 @@
 
 /*** various image pixel extractions ***/
-
-typedef enum { PS_STAT_MODE_MEDIAN } psStatMode;
 
 /// Extract pixels from rectlinear region to a vector.
@@ -271 +269 @@
 );
 
+/* \} */ // End of AstroGroup Functions
+
 # endif
 /* image overlay operations