Mercurial > pidgin.yaz
view pidgin/gtksession.h @ 32635:63e7d226b760
Re-arrange these doxygen comments. For comments longer than a few words,
putting the comment before the variable like this seems cleaner than trying
to cram it on the same line as the variable and using lots of crazy
indentation. Anyone have a strong opinion either way?
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Sun, 18 Sep 2011 20:18:33 +0000 |
parents | 6bf32c9e15a7 |
children |
line wrap: on
line source
/** * @file gtksession.h X Windows session management API * @ingroup pidgin */ /* pidgin * * Pidgin is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA */ #ifndef _PIDGINSESSION_H_ #define _PIDGINSESSION_H_ /**************************************************************************/ /** @name X Windows session subsystem */ /**************************************************************************/ /*@{*/ /** * Register this instance of Pidgin 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. 'purple' * @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/.purple' */ void pidgin_session_init(gchar *argv0, gchar *previous_id, gchar *config_dir); /** * Unregister this instance of Pidgin with the user's current session * manager. */ void pidgin_session_end(void); /*@}*/ #endif /* _PIDGINSESSION_H_ */