Fix GModule documentation a bit

The documentation for g_module_make_resident was for some reason
in the doc comment for g_module_name.

https://bugzilla.gnome.org/show_bug.cgi?id=679813
This commit is contained in:
Matthias Clasen 2012-07-13 17:37:37 -04:00
parent 34b2125edf
commit c182ee1f71
2 changed files with 15 additions and 3 deletions

View File

@ -779,6 +779,13 @@ g_module_close (GModule *module)
return g_module_error() == NULL;
}
/**
* g_module_make_resident:
* @module: a #GModule to make permanently resident
*
* Ensures that a module will never be unloaded.
* Any future g_module_close() calls on the module will be ignored.
*/
void
g_module_make_resident (GModule *module)
{
@ -857,10 +864,13 @@ g_module_symbol (GModule *module,
/**
* g_module_name:
* @module: a #GModule to make permanently resident
* @module: a #GModule
*
* Ensures that a module will never be unloaded.
* Any future g_module_close() calls on the module will be ignored.
* Returns the filename that the module was opened with.
*
* If @module refers to the application itself, "main" is returned.
*
* Returns: (transfer none): the filename of the module
*/
const gchar *
g_module_name (GModule *module)

View File

@ -52,10 +52,12 @@ typedef struct _GModule GModule;
typedef const gchar* (*GModuleCheckInit) (GModule *module);
typedef void (*GModuleUnload) (GModule *module);
#ifndef __GTK_DOC_IGNORE__
#ifdef G_OS_WIN32
#define g_module_open g_module_open_utf8
#define g_module_name g_module_name_utf8
#endif
#endif
/* return TRUE if dynamic module loading is supported */
gboolean g_module_supported (void) G_GNUC_CONST;