Changeset 895 in Sophya for trunk/SophyaLib/SysTools/pdlmgr.cc

Timestamp:

Apr 12, 2000, 7:49:54 PM (25 years ago)

Author:

ansari

Message:

Documentation de fichiers - Reza 12/4/2000

File:

• trunk/SophyaLib/SysTools/pdlmgr.cc (modified) (7 diffs)

trunk/SophyaLib/SysTools/pdlmgr.cc

@@ -18 +18 @@
 string*  PDynLinkMgr::tmpDir = NULL;
 
+/*!
+  \class SOPHYA::PDynLinkMgr
+  This classes handles the run-time operations related to using shared
+  libraries. The present version has been adapted for different Unix 
+  flavours (Linux, Compaq/Digital Unix, SGI IRIX, IBM AIX, Sun Solaris).
+*/
+
 /* --Methode-Static-- */
+/*! Sets the path for a temporary space where shared libraries are copied.
+    The path is appended to \b LD_LIBRARY_PATH
+*/
 void PDynLinkMgr::SetTmpDir(string const & path)
 {
@@ -63 +73 @@
 
 /* --Methode-Static-- */
+/*! Returns the temporary space path */
 string& PDynLinkMgr::GetTmpDir()
 {
@@ -68 +79 @@
   tmpDir = new string("");
   char* varenv;
-  if ( (varenv=getenv("PEIDA_TMP")) != NULL )  *tmpDir = varenv; 
+  if ( (varenv=getenv("SOPHYA_TMP")) != NULL )  *tmpDir = varenv; 
   else if ( (varenv=getenv("TMPDIR")) != NULL )  *tmpDir = varenv; 
   }
@@ -75 +86 @@
 
 /* --Methode-Static-- */
+/*! Compiles the C source file named \b fname and creates the 
+    corresponding shared library linking against the standard 
+    C library (-lc) and the math library (-lm).
+    Returns a pointer to the created PDynLinkMgr object (by new).
+    Returns the NULL pointer in case of errors. 
+*/
 PDynLinkMgr* PDynLinkMgr::BuildFromCFile(string const & fname)
 {
@@ -131 +148 @@
 
 /* --Methode-- */
+/*! The constructor. 
+    \param soname : Name of the shared library. ".so" is appended
+    to the name if no dot "." is found in the name.
+    \param cp : if true, copies the shared library in the temporary space.
+*/ 
 PDynLinkMgr::PDynLinkMgr(string& soname, bool cp)
 {
@@ -181 +203 @@
 
 /* --Methode-- */
+/*! Destructor. Closes the shared library. Removes the file if it had been
+    copied in the temporary space, or generated by \b BuildFromCFile */
 PDynLinkMgr::~PDynLinkMgr()
 {
@@ -196 +220 @@
 
 /* --Methode-- */
+/*! Returns a handle to the function named \b funcname.
+    Returns the NULL pointer in case of error          */
 DlFunction PDynLinkMgr::GetFunction(string const & funcname)
 {