annotate pidgin/gtkidle.h @ 22246:ee80c4ab91ee

Rename 'add_buddies_in_permit' to 'add_all_buddies_to_permit_list' which I think more accurately describes the function, and add comments to 'purple_privacy_allow' and 'purple_privacy_deny' saying that I think the 'local' and 'restore' parameters could be removed. Does anyone know what those parameters are intended to be used for?

/**
 * @file gtkidle.h GTK+ Idle 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 _PIDGIN_IDLE_H_
#define _PIDGIN_IDLE_H_

#include "idle.h"

/**************************************************************************/
/** @name GTK+ Idle API                                                  */
/**************************************************************************/
/*@{*/

/**
 * Returns the GTK+ idle UI ops.
 *
 * @return The UI operations structure.
 */
PurpleIdleUiOps *pidgin_idle_get_ui_ops(void);

/*@}*/

#endif /* _PIDGIN_IDLE_H_ */