Changeset 2321 for trunk/psLib/src/sys/psConfigure.h

Timestamp:

Nov 10, 2004, 10:58:01 AM (22 years ago)

Author:

harman

Message:

Changed comments

File:

• trunk/psLib/src/sys/psConfigure.h (modified) (3 diffs)

trunk/psLib/src/sys/psConfigure.h

@@ -13 +13 @@
  *  @author Robert DeSonia, MHPCC
  *
- *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-11-10 18:26:12 $
+ *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-11-10 20:58:01 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -37 +37 @@
 );
 
-/** Get last error put on the error stack
+/** Initializes persistent memory.
  *
- *  The last error reported is available from psErrorLast; if no errors are
+ *  Creates persistant memory items used throughout psLib. Items created within this method should be freed
+ *  with the psLibFinalize function.
  *  current, a non-NULL psErr is returned with code PS_ERR_NONE.
  *
- *  @return psErr*     Reference to last error message on error stack
+ *  @return void: void.
  */
 void psLibInit(
@@ -54 +55 @@
  *  function at the end of a psLib execution cycle.
  *
+ *  @return void: void.
  */
 void psLibFinalize(