Minor clarification

[wxWidgets.git] / interface / dynlib.h

diff --git a/interface/dynlib.h b/interface/dynlib.h
index 2553defa84f213b1412a7af11a7e5c46940281ff..c38088c1c6080e9fa5580c576746f78517aabb12 100644 (file)
--- a/interface/dynlib.h
+++ b/interface/dynlib.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dynlib.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dynlib.h

-// Purpose:     documentation for wxDynamicLibraryDetails class
+// Purpose:     interface of wxDynamicLibraryDetails

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,80 +9,80 @@
 /**
     @class wxDynamicLibraryDetails
     @wxheader{dynlib.h}
 /**
     @class wxDynamicLibraryDetails
     @wxheader{dynlib.h}

-    
-    This class is used for the objects returned by 
+
+    This class is used for the objects returned by

     wxDynamicLibrary::ListLoaded method and
     contains the information about a single module loaded into the address space of
     the current process. A module in this context may be either a dynamic library
     or the main program itself.
     wxDynamicLibrary::ListLoaded method and
     contains the information about a single module loaded into the address space of
     the current process. A module in this context may be either a dynamic library
     or the main program itself.

-    
+

     @library{wxbase}
     @category{FIXME}
 */
     @library{wxbase}
     @category{FIXME}
 */

-class wxDynamicLibraryDetails 
+class wxDynamicLibraryDetails

 {
 public:
     /**
         Retrieves the load address and the size of this module.
 {
 public:
     /**
         Retrieves the load address and the size of this module.

-        
-        @param addr 
-        the pointer to the location to return load address in, may be
-        @NULL
-        
-        @param len 
-        pointer to the location to return the size of this module in
-        memory in, may be @NULL
-        
+
+        @param addr
+            the pointer to the location to return load address in, may be
+            @NULL
+        @param len
+            pointer to the location to return the size of this module in
+            memory in, may be @NULL
+

         @returns @true if the load address and module size were retrieved, @false
         @returns @true if the load address and module size were retrieved, @false

-                   if this information is not available.
+                 if this information is not available.

     */
     */

-    bool GetAddress(void ** addr, size_t len);
+    bool GetAddress(void** addr, size_t len) const;

 
     /**
 
     /**

-        Returns the base name of this module, e.g. @c kernel32.dll or 
+        Returns the base name of this module, e.g. @c kernel32.dll or

         @c libc-2.3.2.so.
     */
         @c libc-2.3.2.so.
     */

-    wxString GetName();
+    wxString GetName() const;

 
     /**
 
     /**

-        Returns the full path of this module if available, e.g. 
-        @c c:\windows\system32\kernel32.dll or 
+        Returns the full path of this module if available, e.g.
+        @c c:\windows\system32\kernel32.dll or

         @c /lib/libc-2.3.2.so.
     */
         @c /lib/libc-2.3.2.so.
     */

-    wxString GetPath();
+    wxString GetPath() const;

 
     /**
 
     /**

-        Returns the version of this module, e.g. @c 5.2.3790.0 or 
+        Returns the version of this module, e.g. @c 5.2.3790.0 or

         @c 2.3.2. The returned string is empty if the version information is not
         available.
     */
         @c 2.3.2. The returned string is empty if the version information is not
         available.
     */

-    wxString GetVersion();
+    wxString GetVersion() const;

 };
 
 
 };
 
 

+

 /**
     @class wxDllLoader
     @wxheader{dynlib.h}
 /**
     @class wxDllLoader
     @wxheader{dynlib.h}

-    
+

     @b 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 wxDynamicLibrary instead.
     @b 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 wxDynamicLibrary instead.

-    
+

     wxDllLoader is a class providing an interface similar to Unix's @c 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.
     wxDllLoader is a class providing an interface similar to Unix's @c 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 wxDynamicLibrary provides 
+
+    Please note that class wxDynamicLibrary provides

     alternative, friendlier interface to wxDllLoader.
     alternative, friendlier interface to wxDllLoader.

-    
+

     The terms @e DLL and @e shared library/object will both be used in the
     The terms @e DLL and @e shared library/object will both be used in the

-    documentation to refer to the same thing: a @c .dll file under Windows or 
+    documentation to refer to the same thing: a @c .dll file under Windows or

     @c .so or @c .sl one under Unix.
     @c .so or @c .sl one under Unix.

-    
+

     Example of using this class to dynamically load the @c strlen() function:
     Example of using this class to dynamically load the @c strlen() function:

-    
+

     @code
     #if defined(__WXMSW__)
         static const wxChar *LIB_NAME = _T("kernel32");
     @code
     #if defined(__WXMSW__)
         static const wxChar *LIB_NAME = _T("kernel32");


@@ -91,7 +91,7 @@ public:
         static const wxChar *LIB_NAME = _T("/lib/libc-2.0.7.so");
         static const wxChar *FUNC_NAME = _T("strlen");
     #endif
         static const wxChar *LIB_NAME = _T("/lib/libc-2.0.7.so");
         static const wxChar *FUNC_NAME = _T("strlen");
     #endif

-    
+

         wxDllType dllHandle = wxDllLoader::LoadLibrary(LIB_NAME);
         if ( !dllHandle )
         {
         wxDllType dllHandle = wxDllLoader::LoadLibrary(LIB_NAME);
         if ( !dllHandle )
         {


@@ -117,22 +117,21 @@ public:
                     ... ok! ...
                 }
             }
                     ... ok! ...
                 }
             }

-    
+

             wxDllLoader::UnloadLibrary(dllHandle);
         }
     @endcode
             wxDllLoader::UnloadLibrary(dllHandle);
         }
     @endcode

-    
+

     @library{wxbase}
     @category{appmanagement}
 */
     @library{wxbase}
     @category{appmanagement}
 */

-class wxDllLoader 
+class wxDllLoader

 {
 public:
     /**
         Returns the string containing the usual extension for shared libraries for the
         given systems (including the leading dot if not empty).
 {
 public:
     /**
         Returns the string containing the usual extension for shared libraries for the
         given systems (including the leading dot if not empty).

-        
-        For example, this function will return @c ".dll" under Windows or (usually) 
+        For example, this function will return @c ".dll" under Windows or (usually)

         @c ".so" under Unix.
     */
     static wxString GetDllExt();
         @c ".so" under Unix.
     */
     static wxString GetDllExt();


@@ -141,8 +140,7 @@ public:
         This function returns a valid handle for the main program itself. Notice that
         the @NULL return value is valid for some systems (i.e. doesn't mean that
         the function failed).
         This function returns a valid handle for the main program itself. Notice that
         the @NULL return value is valid for some systems (i.e. doesn't mean that
         the function failed).

-        
-        @b NB: This function is Unix specific. It will always fail under Windows
+        @note This function is Unix specific. It will always fail under Windows

         or OS/2.
     */
     wxDllType GetProgramHandle();
         or OS/2.
     */
     wxDllType GetProgramHandle();


@@ -150,64 +148,60 @@ public:
     /**
         This function resolves a symbol in a loaded DLL, such as a variable or
         function name.
     /**
         This function resolves a symbol in a loaded DLL, such as a variable or
         function name.

-        

         Returned value will be @NULL if the symbol was not found in the DLL or if
         an error occurred.
         Returned value will be @NULL if the symbol was not found in the DLL or if
         an error occurred.

-        
-        @param dllHandle 
-        Valid handle previously returned by 
-        LoadLibrary
-        
-        @param name 
-        Name of the symbol.
+
+        @param dllHandle
+            Valid handle previously returned by
+            LoadLibrary
+        @param name
+            Name of the symbol.

     */
     */

-    void * GetSymbol(wxDllType dllHandle, const wxString& name);
+    void* GetSymbol(wxDllType dllHandle, const wxString& name);

 
     /**
 
     /**

-        This function loads a shared library into memory, with @e libname being the
+        This function loads a shared library into memory, with @a libname being the

         name of the library: it may be either the full name including path and
         (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.
         name of the library: it may be either the full name including path and
         (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 @e success parameter to test if it
-        is valid. If the handle is valid, the library must be unloaded later with 
+        Returns a handle to the loaded DLL. Use @a success parameter to test if it
+        is valid. If the handle is valid, the library must be unloaded later with

         UnloadLibrary().
         UnloadLibrary().

-        
-        @param libname 
-        Name of the shared object to load.
-        
-        @param success 
-        May point to a bool variable which will be set to @true or
-        @false; may also be @NULL.
+
+        @param libname
+            Name of the shared object to load.
+        @param success
+            May point to a bool variable which will be set to @true or
+            @false; may also be @NULL.

     */
     */

-    wxDllType LoadLibrary(const wxString & libname,
-                          bool* success = @NULL);
+    wxDllType LoadLibrary(const wxString& libname,
+                          bool* success = NULL);

 
     /**
 
     /**

-        This function unloads the shared library. The handle @e dllhandle must have
+        This function unloads the shared library. The handle @a dllhandle must have

         been returned by LoadLibrary() previously.
     */
     void UnloadLibrary(wxDllType dllhandle);
 };
 
 
         been returned by LoadLibrary() previously.
     */
     void UnloadLibrary(wxDllType dllhandle);
 };
 
 

+

 /**
     @class wxDynamicLibrary
     @wxheader{dynlib.h}
 /**
     @class wxDynamicLibrary
     @wxheader{dynlib.h}

-    
+

     wxDynamicLibrary is a class representing dynamically loadable library
     (Windows DLL, shared library under Unix etc.). Just create an object of
     this class to load a library and don't worry about unloading it -- it will be
     done in the objects destructor automatically.
     wxDynamicLibrary is a class representing dynamically loadable library
     (Windows DLL, shared library under Unix etc.). Just create an object of
     this class to load a library and don't worry about unloading it -- it will be
     done in the objects destructor automatically.

-    
+

     @library{wxbase}
     @category{FIXME}
     @library{wxbase}
     @category{FIXME}

-    
-    @seealso
-    wxDynamicLibrary::CanonicalizePluginName
+
+    @see wxDynamicLibrary::CanonicalizePluginName

 */
 */

-class wxDynamicLibrary 
+class wxDynamicLibrary

 {
 public:
     //@{
 {
 public:
     //@{


@@ -215,58 +209,45 @@ public:
         Constructor. Second form calls Load().
     */
     wxDynamicLibrary();
         Constructor. Second form calls Load().
     */
     wxDynamicLibrary();

-        wxDynamicLibrary(const wxString& name,
-                         int flags = wxDL_DEFAULT);
+    wxDynamicLibrary(const wxString& name,
+                     int flags = wxDL_DEFAULT);

     //@}
 
     /**
         Returns the platform-specific full name for the library called @e name. E.g.
     //@}
 
     /**
         Returns the platform-specific full name for the library called @e name. E.g.

-        it adds a @c ".dll" extension under Windows and @c "lib" prefix and 
+        it adds a @c ".dll" extension under Windows and @c "lib" prefix and

         @c ".so", @c ".sl" or maybe @c ".dylib" extension under Unix.
         @c ".so", @c ".sl" or maybe @c ".dylib" extension under Unix.

-        
-        The possible values for @e cat are:
-        
-            
-        
+        The possible values for @a cat are:
+
+

         wxDL_LIBRARY
         wxDL_LIBRARY

-        
-        
+

         normal library
         normal library

-        
-            
-        
+

         wxDL_MODULE
         wxDL_MODULE

-        
-        
+

         a loadable module or plugin
         a loadable module or plugin

-        
-        
-        @sa CanonicalizePluginName()
+
+        @see CanonicalizePluginName()

     */
     static wxString CanonicalizeName(const wxString& name,
                                      wxDynamicLibraryCategory cat = wxDL_LIBRARY);
 
     /**
     */
     static wxString CanonicalizeName(const wxString& name,
                                      wxDynamicLibraryCategory cat = wxDL_LIBRARY);
 
     /**

-        This function does the same thing as 
+        This function does the same thing as

         CanonicalizeName() but for wxWidgets
         plugins. The only difference is that compiler and version information are added
         to the name to ensure that the plugin which is going to be loaded will be
         compatible with the main program.
         CanonicalizeName() but for wxWidgets
         plugins. The only difference is that compiler and version information are added
         to the name to ensure that the plugin which is going to be loaded will be
         compatible with the main program.

-        
-        The possible values for @e cat are:
-        
-            
-        
+        The possible values for @a cat are:
+
+

         wxDL_PLUGIN_GUI
         wxDL_PLUGIN_GUI

-        
-        
+

         plugin which uses GUI classes (default)
         plugin which uses GUI classes (default)

-        
-            
-        
+

         wxDL_PLUGIN_BASE
         wxDL_PLUGIN_BASE

-        
-        
+

         plugin which only uses wxBase
     */
     static wxString CanonicalizePluginName(const wxString& name,
         plugin which only uses wxBase
     */
     static wxString CanonicalizePluginName(const wxString& name,


@@ -286,12 +267,12 @@ public:
     static wxDllType GetProgramHandle();
 
     /**
     static wxDllType GetProgramHandle();
 
     /**

-        Returns pointer to symbol @e name in the library or @NULL if the library
+        Returns pointer to symbol @a name in the library or @NULL if the library

         contains no such symbol.
         contains no such symbol.

-        
-        @sa wxDYNLIB_FUNCTION
+
+        @see wxDYNLIB_FUNCTION()

     */
     */

-    void * GetSymbol(const wxString& name);
+    void* GetSymbol(const wxString& name) const;

 
     /**
         This function is available only under Windows as it is only useful when
 
     /**
         This function is available only under Windows as it is only useful when


@@ -302,69 +283,62 @@ public:
         automatically depending on the current build. Otherwise, this method is
         identical to GetSymbol().
     */
         automatically depending on the current build. Otherwise, this method is
         identical to GetSymbol().
     */

-    void * GetSymbolAorW(const wxString& name);
+    void* GetSymbolAorW(const wxString& name) const;

 
     /**
 
     /**

-        Returns @true if the symbol with the given @e name is present in the dynamic
+        Returns @true if the symbol with the given @a name is present in the dynamic

         library, @false otherwise. Unlike GetSymbol(),
         this function doesn't log an error message if the symbol is not found.
         library, @false otherwise. Unlike GetSymbol(),
         this function doesn't log an error message if the symbol is not found.

-        
-        This function is new since wxWidgets version 2.5.4
+
+        @wxsince{2.5.4}

     */
     */

-    bool HasSymbol(const wxString& name);
+    bool HasSymbol(const wxString& name) const;

 
     /**
         Returns @true if the library was successfully loaded, @false otherwise.
     */
 
     /**
         Returns @true if the library was successfully loaded, @false otherwise.
     */

-    bool IsLoaded();
+    bool IsLoaded() const;

 
     /**
 
     /**

-        This static method returns an array containing the details
+        This static method returns an array() containing the details

         of all modules loaded into the address space of the current project, the array
         elements are object of @c wxDynamicLibraryDetails class. The array will
         be empty if an error occurred.
         of all modules loaded into the address space of the current project, the array
         elements are object of @c wxDynamicLibraryDetails class. The array will
         be empty if an error occurred.

-        

         This method is currently implemented only under Win32 and Linux and is useful
         mostly for diagnostics purposes.
     */
     static wxDynamicLibraryDetailsArray ListLoaded();
 
     /**
         This method is currently implemented only under Win32 and Linux and is useful
         mostly for diagnostics purposes.
     */
     static wxDynamicLibraryDetailsArray ListLoaded();
 
     /**

-        Loads DLL with the given @e name into memory. The @e flags argument can
+        Loads DLL with the given @a name into memory. The @a flags argument can

         be a combination of the following bits:
         be a combination of the following bits:

-        
+

         wxDL_LAZY
         wxDL_LAZY

-        
-        
+

         equivalent of RTLD_LAZY under Unix, ignored elsewhere
         equivalent of RTLD_LAZY under Unix, ignored elsewhere

-        
+

         wxDL_NOW
         wxDL_NOW

-        
-        
+

         equivalent of RTLD_NOW under Unix, ignored elsewhere
         equivalent of RTLD_NOW under Unix, ignored elsewhere

-        
+

         wxDL_GLOBAL
         wxDL_GLOBAL

-        
-        
+

         equivalent of RTLD_GLOBAL under Unix, ignored elsewhere
         equivalent of RTLD_GLOBAL under Unix, ignored elsewhere

-        
+

         wxDL_VERBATIM
         wxDL_VERBATIM

-        
-        
+

         don't try to append the appropriate extension to
         the library name (this is done by default).
         don't try to append the appropriate extension to
         the library name (this is done by default).

-        
+

         wxDL_DEFAULT
         wxDL_DEFAULT

-        
-        
+

         default flags, same as wxDL_NOW currently
         default flags, same as wxDL_NOW currently

-        
+

         wxDL_QUIET
         wxDL_QUIET

-        
-        
+

         don't log an error message if the library couldn't be
         loaded.
         don't log an error message if the library couldn't be
         loaded.

-        
+

         Returns @true if the library was successfully loaded, @false otherwise.
     */
     bool Load(const wxString& name, int flags = wxDL_DEFAULT);
         Returns @true if the library was successfully loaded, @false otherwise.
     */
     bool Load(const wxString& name, int flags = wxDL_DEFAULT);


@@ -373,43 +347,47 @@ public:
     /**
         Unloads the library from memory. wxDynamicLibrary object automatically calls
         this method from its destructor if it had been successfully loaded.
     /**
         Unloads the library from memory. wxDynamicLibrary object automatically calls
         this method from its destructor if it had been successfully loaded.

-        

         The second version is only used if you need to keep the library in memory
         during a longer period of time than the scope of the wxDynamicLibrary object.
         In this case you may call Detach() and store
         the handle somewhere and call this static method later to unload it.
     */
     void Unload();
         The second version is only used if you need to keep the library in memory
         during a longer period of time than the scope of the wxDynamicLibrary object.
         In this case you may call Detach() and store
         the handle somewhere and call this static method later to unload it.
     */
     void Unload();

-        static void Unload(wxDllType handle);
+    static void Unload(wxDllType handle);

     //@}
 };
 
 
     //@}
 };
 
 

+

 // ============================================================================
 // Global functions/macros
 // ============================================================================
 
 // ============================================================================
 // Global functions/macros
 // ============================================================================
 

+/** @ingroup group_funcmacro_misc */
+//@{
+

 /**
     When loading a function from a DLL you always have to cast the returned
 /**
     When loading a function from a DLL you always have to cast the returned

-    @c void * pointer to the correct type and, even more annoyingly, you have to
-    repeat this type twice if you want to declare and define a function pointer all
-    in one line
-    
+    <tt>void *</tt> pointer to the correct type and, even more annoyingly, you
+    have to repeat this type twice if you want to declare and define a function
+    pointer all in one line.
+

     This macro makes this slightly less painful by allowing you to specify the
     This macro makes this slightly less painful by allowing you to specify the

-    type only once, as the first parameter, and creating a variable of this type
-    named after the function but with @c pfn prefix and initialized with the
-    function @e name from the wxDynamicLibrary
-    @e dynlib.
-    
-    @param type 
-    the type of the function
-    
-    @param name 
-    the name of the function to load, not a string (without quotes,
-    it is quoted automatically by the macro)
-    
-    @param dynlib 
-    the library to load the function from
+    type only once, as the first parameter, and creating a variable of this
+    type named after the function but with @c pfn prefix and initialized with
+    the function @a name from the wxDynamicLibrary @a dynlib.
+
+    @param type
+        The type of the function.
+    @param name
+        The name of the function to load, not a string (without quotes, it is
+        quoted automatically by the macro).
+    @param dynlib
+        The library to load the function from.
+
+    @header{wx/dynlib.h}

 */
 */

-#define wxDYNLIB_FUNCTION(type,  name,  dynlib)     /* implementation is private */
+#define wxDYNLIB_FUNCTION(type, name, dynlib)
+
+//@}