GModule: Move docs away from markup

This commit is contained in:
Matthias Clasen 2014-02-01 11:08:23 -05:00
parent 4ab94a2683
commit 6972264c7d

View File

@ -79,9 +79,8 @@
* <literal>g_quark_from_static_string ("my-module-stuff")</literal>, * <literal>g_quark_from_static_string ("my-module-stuff")</literal>,
* it must ensure that it is never unloaded, by calling g_module_make_resident(). * it must ensure that it is never unloaded, by calling g_module_make_resident().
* *
* <example> * Example: Calling a function defined in a GModule
* <title>Calling a function defined in a GModule</title> * |[
* <programlisting>
* /&ast; the function signature for 'say_hello' &ast;/ * /&ast; the function signature for 'say_hello' &ast;/
* typedef void (* SayHelloFunc) (const char *message); * typedef void (* SayHelloFunc) (const char *message);
* *
@ -95,16 +94,16 @@
* if (!module) * if (!module)
* { * {
* g_set_error (error, FOO_ERROR, FOO_ERROR_BLAH, * g_set_error (error, FOO_ERROR, FOO_ERROR_BLAH,
* "&percnt;s", g_module_error ()); * "%s", g_module_error ());
* return FALSE; * return FALSE;
* } * }
* *
* if (!g_module_symbol (module, "say_hello", (gpointer *)&amp;say_hello)) * if (!g_module_symbol (module, "say_hello", (gpointer *)&say_hello))
* { * {
* g_set_error (error, SAY_ERROR, SAY_ERROR_OPEN, * g_set_error (error, SAY_ERROR, SAY_ERROR_OPEN,
* "&percnt;s: &percnt;s", filename, g_module_error ()); * "%s: %s", filename, g_module_error ());
* if (!g_module_close (module)) * if (!g_module_close (module))
* g_warning ("&percnt;s: &percnt;s", filename, g_module_error ()); * g_warning ("%s: %s", filename, g_module_error ());
* return FALSE; * return FALSE;
* } * }
* *
@ -113,7 +112,7 @@
* g_set_error (error, SAY_ERROR, SAY_ERROR_OPEN, * g_set_error (error, SAY_ERROR, SAY_ERROR_OPEN,
* "symbol say_hello is NULL"); * "symbol say_hello is NULL");
* if (!g_module_close (module)) * if (!g_module_close (module))
* g_warning ("&percnt;s: &percnt;s", filename, g_module_error ()); * g_warning ("%s: %s", filename, g_module_error ());
* return FALSE; * return FALSE;
* } * }
* *
@ -121,11 +120,10 @@
* say_hello ("Hello world!"); * say_hello ("Hello world!");
* *
* if (!g_module_close (module)) * if (!g_module_close (module))
* g_warning ("&percnt;s: &percnt;s", filename, g_module_error ()); * g_warning ("%s: %s", filename, g_module_error ());
* return TRUE; * return TRUE;
* } * }
* </programlisting> * ]|
* </example>
*/ */
/** /**
@ -141,7 +139,6 @@
* @module: the #GModule corresponding to the module which has just been loaded * @module: the #GModule corresponding to the module which has just been loaded
* *
* Specifies the type of the module initialization function. * Specifies the type of the module initialization function.
* <indexterm zone="g-module-check-init"><primary>g_module_check_init</primary></indexterm>
* If a module contains a function named g_module_check_init() it is called * If a module contains a function named g_module_check_init() it is called
* automatically when the module is loaded. It is passed the #GModule structure * automatically when the module is loaded. It is passed the #GModule structure
* and should return %NULL on success or a string describing the initialization * and should return %NULL on success or a string describing the initialization
@ -154,7 +151,6 @@
* GModuleUnload: * GModuleUnload:
* @module: the #GModule about to be unloaded * @module: the #GModule about to be unloaded
* *
* <indexterm zone="g-module-unload"><primary>g_module_unload</primary></indexterm>
* Specifies the type of the module function called when it is unloaded. * Specifies the type of the module function called when it is unloaded.
* If a module contains a function named g_module_unload() it is called * If a module contains a function named g_module_unload() it is called
* automatically when the module is unloaded. * automatically when the module is unloaded.