Described in the comments and documented the semantics of the parameters and

[wxWidgets.git] / docs / latex / wx / dllload.tex

diff --git a/docs/latex/wx/dllload.tex b/docs/latex/wx/dllload.tex
index dc4210e08dc98e00f1bd0a192efe64b7fe630729..c0f217dfd2be0545f90c9f96153693057fe1babd 100644 (file)
--- a/docs/latex/wx/dllload.tex
+++ b/docs/latex/wx/dllload.tex
@@ -11,17 +11,25 @@
 
 \section{\class{wxDllLoader}}\label{wxdllloader}
 
+\textbf{Deprecation note: } This class is deprecated since version 2.4 and is
+not compiled in by default in version 2.6 and will be removed in 2.8. Please
+use \helpref{wxDynamicLibrary}{wxdynamiclibrary} instead.
+
+
 wxDllLoader is a class providing an interface similar to Unix's {\tt
 dlopen()}. It is used by the wxLibrary framework and manages the actual
 loading of shared libraries and the resolving of symbols in them. There are no
 instances of this class, it simply serves as a namespace for its static member
 functions.
 
+Please note that class \helpref{wxDynamicLibrary}{wxdynamiclibrary} provides 
+alternative, friendlier interface to wxDllLoader.
+
 The terms {\it DLL} and {\it shared library/object} will both be used in the
 documentation to refer to the same thing: a {\tt .dll} file under Windows or 
 {\tt .so} or {\tt .sl} one under Unix.
 
-Example of using this class to dynamically load {\tt strlen()} function:
+Example of using this class to dynamically load the {\tt strlen()} function:
 
 \begin{verbatim}
 #if defined(__WXMSW__)
@@ -71,7 +79,7 @@ No base class
 
 \wxheading{Data structures}
 
-This header defines a platfrom-dependent {\tt wxDllType} typedef which stores
+This header defines a platform-dependent {\tt wxDllType} typedef which stores
 a handle to a loaded DLLs on the given platform.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -105,7 +113,7 @@ This function resolves a symbol in a loaded DLL, such as a variable or
 function name.
 
 Returned value will be {\tt NULL} if the symbol was not found in the DLL or if
-an error occured.
+an error occurred.
 
 \wxheading{Parameters}
 
@@ -120,8 +128,8 @@ an error occured.
 
 This function loads a shared library into memory, with {\it libname} being the
 name of the library: it may be either the full name including path and
-(platform-dependent) extenesion, just the basename (no path and no extension)
-or a basename with extentsion. In the last two cases, the library will be
+(platform-dependent) extension, just the basename (no path and no extension)
+or a basename with extension. In the last two cases, the library will be
 searched in all standard locations.
 
 Returns a handle to the loaded DLL. Use {\it success} parameter to test if it
@@ -132,8 +140,8 @@ is valid. If the handle is valid, the library must be unloaded later with
 
 \docparam{libname}{Name of the shared object to load.}
 
-\docparam{success}{May point to a bool variable which will be set to TRUE or
-FALSE; may also be {\tt NULL}.}
+\docparam{success}{May point to a bool variable which will be set to true or
+false; may also be {\tt NULL}.}
 
 \membersection{wxDllLoader::UnloadLibrary}\label{wxdllloaderunloadlibrary}
 
@@ -142,4 +150,3 @@ FALSE; may also be {\tt NULL}.}
 This function unloads the shared library. The handle {\it dllhandle} must have
 been returned by \helpref{LoadLibrary}{wxdllloaderloadlibrary} previously.
 
-