comparison libpurple/core.h @ 22010:7e5ecf03b69d

Clarify a comment that was confusing me. Thanks resiak!
author Richard Laager <rlaager@wiktel.com>
date Sat, 05 Jan 2008 17:14:32 +0000
parents f296be2a1039
children 09697d94160f
comparison
equal deleted inserted replaced
22009:1494e0a0f2b9 22010:7e5ecf03b69d
65 65
66 /** 66 /**
67 * Calls purple_core_quit(). This can be used as the function 67 * Calls purple_core_quit(). This can be used as the function
68 * passed to purple_timeout_add() when you want to shutdown Purple 68 * passed to purple_timeout_add() when you want to shutdown Purple
69 * in a specified amount of time. When shutting down Purple 69 * in a specified amount of time. When shutting down Purple
70 * from a plugin, you must use this with a timeout value of 0: 70 * from a plugin, you must use this instead of purple_core_quit();
71 * for an immediate exit, use a timeout value of 0:
71 * purple_timeout_add(0, purple_core_quitcb, NULL); 72 * purple_timeout_add(0, purple_core_quitcb, NULL);
72 * This is ensures that code from your plugin is not being 73 * This is ensures that code from your plugin is not being
73 * executed when purple_core_quit() is called. Otherwise you 74 * executed when purple_core_quit() is called. If the plugin
74 * would get a core dump after purple_core_quit() executes and 75 * called purple_core_quit() directly, you would get a core dump
75 * control returns to your plugin because purple_core_quit() frees 76 * after purple_core_quit() executes and control returns to your
76 * all plugins. 77 * plugin because purple_core_quit() frees all plugins.
77 */ 78 */
78 gboolean purple_core_quit_cb(gpointer unused); 79 gboolean purple_core_quit_cb(gpointer unused);
79 80
80 /** 81 /**
81 * Returns the version of the core library. 82 * Returns the version of the core library.