Mercurial > pidgin.yaz
view pidgin/gtkprivacy.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 gtkprivacy.h GTK+ Privacy UI * @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 _PIDGINPRIVACY_H_ #define _PIDGINPRIVACY_H_ #include "privacy.h" /** * Initializes the GTK+ privacy subsystem. */ void pidgin_privacy_init(void); /** * Shows the privacy dialog. */ void pidgin_privacy_dialog_show(void); /** * Hides the privacy dialog. */ void pidgin_privacy_dialog_hide(void); /** * Requests confirmation to add a user to the allow list for an account, * and then adds it. * * If @a name is not specified, an input dialog will be presented. * * @param account The account. * @param name The name of the user to add. */ void pidgin_request_add_permit(PurpleAccount *account, const char *name); /** * Requests confirmation to add a user to the block list for an account, * and then adds it. * * If @a name is not specified, an input dialog will be presented. * * @param account The account. * @param name The name of the user to add. */ void pidgin_request_add_block(PurpleAccount *account, const char *name); /** * Returns the UI operations structure for the GTK+ privacy subsystem. * * @return The GTK+ UI privacy operations structure. */ PurplePrivacyUiOps *pidgin_privacy_get_ui_ops(void); #endif /* _PIDGINPRIVACY_H_ */