Changeset 7901 for trunk/psLib/src/sys/psLine.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/sys/psLine.h (modified) (3 diffs)

trunk/psLib/src/sys/psLine.h

@@ -1 +1 @@
 /** @file  psLine.h
  *
- * the psLine functions allow manipulation of fixed-length lines
+ *
+ *  @brief Contains the declarations of line utility functions
+ *
+ *  @ingroup SysUtils
+ *
+ *  The psLine functions allow manipulation of fixed-length lines.
+ *
+ *  @author Paul Price, IFA
+ *  @author David Robbins, MHPCC
+ *
+ *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-07-14 02:26:25 $
+ *
+ *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
  */
 
 #ifndef PS_LINE_H
 #define PS_LINE_H
+
+/** @addtogroup SysUtils
+ *  @{
+ */
 
 /** Structure to carry a dynamic string */
@@ -16 +33 @@
 psLine;
 
-/** Allocates a line object of length Nline
+/** Allocates a line object of length Nline.
  *
  *  @return psLine*:        the newly allocated line object.
 */
 psLine *psLineAlloc(
-    long Nline                         ///<
+    long Nline                         ///< length of line object to allocate
+);
+
+/** 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 psLine structure, false otherwise.
+ */
+bool psMemCheckLine(
+    psPtr ptr                          ///< the pointer whose type to check
 );
 
@@ -32 +59 @@
 */
 bool psLineInit(
-    psLine *line                       ///<
+    psLine *line                       ///< line to (re-)initialize
 );