annotate pidgin/gtkdebug.h @ 28340:ea3e672e356b

Split the descriptions of our --help text up into multiple smaller strings. This also doesn't allow translators to translate the parameters, since that would break them. It seems like it would be good if those strings were translatable, too, but that's a bigger change than I'm willing to make right now. This also eliminates the two almost identical blocks of text we had in order to not show the --display option in Windows.

/**
 * @file gtkdebug.h GTK+ Debug 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 _PIDGINDEBUG_H_
#define _PIDGINDEBUG_H_

#include "debug.h"

/**
 * Initializes the GTK+ debug system.
 */
void pidgin_debug_init(void);

/**
 * Uninitialized the GTK+ debug system.
 */
void pidgin_debug_uninit(void);

/**
 * Get the handle for the GTK+ debug system.
 *
 * @return the handle to the debug system
 */
void *pidgin_debug_get_handle(void);

/**
 * Shows the debug window.
 */
void pidgin_debug_window_show(void);

/**
 * Hides the debug window.
 */
void pidgin_debug_window_hide(void);

/**
 * Returns the UI operations structure for GTK+ debug output.
 *
 * @return The GTK+ UI debug operations structure.
 */
PurpleDebugUiOps *pidgin_debug_get_ui_ops(void);

#endif /* _PIDGINDEBUG_H_ */