diff src/gtksession.h @ 12247:99416d2f609f

[gaim-migrate @ 14549] I forgot to document these. Rats to you, Robert Bernoulli! committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Mon, 28 Nov 2005 06:25:21 +0000
parents b7a51e68d0b8
children fc464a0abccc
line wrap: on
line diff
--- a/src/gtksession.h	Mon Nov 28 06:20:06 2005 +0000
+++ b/src/gtksession.h	Mon Nov 28 06:25:21 2005 +0000
@@ -31,12 +31,20 @@
 /*@{*/
 
 /**
- * TODO
+ * Register this instance of Gaim with the user's current session
+ * manager.
+ *
+ * @param argv0       The first argument passed into the program.  This
+ *                    will be the name of the executable, e.g. 'gaim'
+ * @param previous_id An optional session ID to use.  This can be NULL.
+ * @param config_dir  The path to the configuration directory used by
+ *                    this instance of this program, e.g. '/home/user/.gaim'
  */
 void gaim_gtk_session_init(gchar *argv0, gchar *previous_id, gchar *config_dir);
 
 /**
- * TODO
+ * Unregister this instance of Gaim with the user's current session
+ * manager.
  */
 void gaim_gtk_session_end();