annotate console/gntdebug.h @ 15000:89ae31668a9c

[gaim-migrate @ 17779] I'm committing this to get it out of my tree... As mentioned on gaim-devel, this normalizes some stuff. Mark wants to standardize on "username" instead. For recognition purposes, I'd prefer that, but using "screen name" is potentially useful in that users might not enter their OS username. In any case, it's not a huge deal to me either way. I believe the consensus before was for "screen name", and barring a consensus to change, "screen name" is the status quo anyway, so I'm making things consistent. committer: Tailor Script <[e-mail]>

/**
 * @file gntdebug.h GNT Debug API
 * @ingroup gntui
 *
 * gaim
 *
 * Gaim 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef _GNT_DEBUG_H
#define _GNT_DEBUG_H

#include "debug.h"

/**********************************************************************
 * @name GNT Debug API
 **********************************************************************/
/*@{*/

/**
 * Get the ui-functions.
 *
 * @return The GaimDebugUiOps structure populated with the appropriate functions.
 */
GaimDebugUiOps *gg_debug_get_ui_ops(void);

/**
 * Perform necessary initializations.
 */
void gg_debug_init(void);

/**
 * Perform necessary uninitializations.
 */
void gg_debug_uninit(void);

/**
 * Show the debug window.
 */
void gg_debug_window_show(void);

/*@}*/

#endif