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

Timestamp:

Jun 7, 2005, 12:53:40 PM (21 years ago)

Author:

gusciora

Message:

Removed code that freed data structures that were declared static for
performance reasons. This issue will be addressed later.

File:

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

trunk/psLib/src/sys/psConfigure.h

@@ -1 +1 @@
 /** @file  psConfigure.h
  *
- *  @brief Contains the declarations for initialization, memory finalization, and configuration.
+ *  @brief Contains the declarations for initialization, memory finalization,
+ *   and configuration.
  *
- *  These functions initalize psLib data before the beginning of a run and remove (finalize) the
- *  same data after the run is complete. A function is also provided to return the current
- *  psLib version.
+ *  These functions initalize psLib data before the beginning of a run and
+ *  remove (finalize) the same data after the run is complete.  A function is
+ *  also provided to return the current psLib version.
  *
  *  @ingroup Configure
  *
  *  @author Ross Harman, MHPCC
- *  @author George Gusciora, MHPCC
  *  @author Robert DeSonia, MHPCC
  *
- *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-02-17 19:26:24 $
+ *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-07 22:53:40 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -21 +21 @@
 #ifndef PS_CONFIGURE_H
 #define PS_CONFIGURE_H
-
 
 /** @addtogroup Configure
@@ -39 +38 @@
 /** Initializes persistent memory.
  *
- *  Creates persistant memory items used throughout psLib. Items created within this method should be freed
- *  with the psLibFinalize function.
+ *  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.
  *
@@ -47 +46 @@
 void psLibInit(
     bool predictable,
-    const char* timeConfig
+    const char* timeConfig           ///< Filename of config file for psTime.
 );
 
 /** Removes persistant memory created with the psLibInit function.
  *
- *  The memory created but not freed by psLib modules should be freed within this
- *  function at the end of a psLib execution cycle.
+ *  The memory created but not freed by psLib modules should be freed
+ *  within this function at the end of a psLib execution cycle.
  *
  *  @return void: void.