Changeset 8312 for trunk/psLib/src/math/psRegion.h

Timestamp:

Aug 14, 2006, 10:05:05 AM (20 years ago)

Author:

drobbin

Message:

Updated doxygen in region. Updated printing in metadata. Updated itemPrint in MetaConfig. Edited MetaItemCompare tap test and added/updated MetaItemParse tap test

File:

• trunk/psLib/src/math/psRegion.h (modified) (5 diffs)

trunk/psLib/src/math/psRegion.h

@@ -11 +11 @@
 typedef struct
 {
-    float x0;                         ///< the first column of the region.
-    float x1;                         ///< the last column of the region.
-    float y0;                         ///< the first row of the region.
-    float y1;                         ///< the last row of the region.
+    float x0;                          ///< the first column of the region.
+    float x1;                          ///< the last column of the region.
+    float y0;                          ///< the first row of the region.
+    float y1;                          ///< the last row of the region.
 }
 psRegion;
@@ -22 +22 @@
  * @return psRegion* : a new psRegion.
  */
-psRegion *psRegionAlloc(float x0,       ///< the first column of the region.
-                        float x1,       ///< the last column of the region + 1.
-                        float y0,       ///< the first row of the region.
-                        float y1        ///< the last row of the region + 1.
-                       );
+psRegion *psRegionAlloc(
+    float x0,                          ///< the first column of the region.
+    float x1,                          ///< the last column of the region + 1.
+    float y0,                          ///< the first row of the region.
+    float y1                           ///< the last row of the region + 1.
+);
 
 /** Checks the type of a particular pointer.
@@ -40 +41 @@
 /** Create a psRegion with the specified attributes.
  *
- *  @return psRegion : a cooresponding psRegion.
+ *  @return psRegion :      a corresponding psRegion.
  */
 psRegion psRegionSet(
@@ -54 +55 @@
  *  shall be of the standard IRAF form '[x0:x1,y0:y1]'
  *
- *  @return psRegion:  A new psRegion struct, or NULL is not successful.
+ *  @return psRegion:       A new psRegion struct, or NULL is not successful.
  */
 psRegion psRegionFromString(
@@ -75 +76 @@
  */
 psRegion psRegionForSquare(
-    double x,                           ///< x coordinate at square-center
-    double y,                           ///< y coordinate at square-center
-    double radius                       ///< radius of square
+    double x,                          ///< x coordinate at square-center
+    double y,                          ///< y coordinate at square-center
+    double radius                      ///< radius of square
 );