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

Timestamp:

Jul 13, 2006, 4:26:25 PM (20 years ago)

Author:

drobbin

Message:

Added str check test for error handling of psString fxns, namely stringSubstitute. Edited memory and type to include MemCheck's for string, line, and region. Added is_psType function to check for NULLs and native types first. <-will have to update all fxns next wrt to this change. Added psStringAlloc, stringFree, regionFree. Added doxygen comments.

File:

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

trunk/psLib/src/math/psRegion.h

@@ -27 +27 @@
                         float y1        ///< the last row of the region + 1.
                        );
+
+/** Checks the type of a particular pointer.
+ *
+ *  Uses the appropriate deallocation function in psMemBlock to check the ptr datatype.
+ *
+ *  @return bool:       True if the pointer matches a psRegion structure, false otherwise.
+ */
+bool psMemCheckRegion(
+    psPtr ptr                          ///< the pointer whose type to check
+);
 
 /** Create a psRegion with the specified attributes.
@@ -70 +80 @@
 );
 
-// Test if any element of the region is NaN
-bool psRegionIsNaN(psRegion region// Region to check
-                  );
+/** Test if any element of the region is NaN
+ *
+ * @return bool:        True if an element is NaN, otherwise false.
+ */
+bool psRegionIsNaN(
+    psRegion region                    ///< Region to check
+);
 
 #endif