]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/dynlib.h
Implement monitoring of file descriptors in wxMotif event loop.
[wxWidgets.git] / interface / wx / dynlib.h
index 3392ef4f1910ab5075bffff91b956c0bad03cfc0..3c3baeaadafb539965463cb4d79a9abfaaa35b69 100644 (file)
@@ -3,12 +3,11 @@
 // Purpose:     interface of wxDynamicLibrary and wxDynamicLibraryDetails
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxDynamicLibraryDetails
-    @wxheader{dynlib.h}
 
     This class is used for the objects returned by the
     wxDynamicLibrary::ListLoaded() method and contains the information about a
@@ -35,22 +34,22 @@ public:
         @return @true if the load address and module size were retrieved,
                  @false if this information is not available.
     */
-    bool GetAddress(void** addr, size_t len) const;
+    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".
     */
     wxString GetName() const;
 
     /**
-        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".
+        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".
     */
     wxString GetPath() const;
 
     /**
-        Returns the version of this module, e.g. @c "5.2.3790.0" or @c "2.3.2".
+        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.
     */
@@ -80,10 +79,9 @@ enum wxPluginCategory
 
 /**
     @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
+    (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.
 
@@ -140,7 +138,7 @@ public:
                                            wxPluginCategory cat = wxDL_PLUGIN_GUI);
 
     /**
-        Detaches this object from its library handle, i.e. the object will not
+        Detaches this object from its library handle, i.e.\ the object will not
         unload the library any longer in its destructor but it is now the
         callers responsibility to do this using Unload().
     */
@@ -158,7 +156,7 @@ public:
 
         @see wxDYNLIB_FUNCTION()
     */
-    void* GetSymbol(const wxString& name) const;
+    void* GetSymbol(const wxString& name, bool* success = 0) const;
 
     /**
         This function is available only under Windows as it is only useful when
@@ -168,6 +166,8 @@ public:
         function, you can use just the base name of the function and the
         correct suffix is appended automatically depending on the current
         build. Otherwise, this method is identical to GetSymbol().
+
+        @onlyfor{wxmsw}
     */
     void* GetSymbolAorW(const wxString& name) const;
 
@@ -229,7 +229,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
-/** @ingroup group_funcmacro_misc */
+/** @addtogroup group_funcmacro_misc */
 //@{
 
 /**