Mercurial > pidgin
changeset 14558:81650a27f253
[gaim-migrate @ 17281]
Doxygen for console/
committer: Tailor Script <tailor@pidgin.im>
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Fri, 15 Sep 2006 01:21:53 +0000 |
parents | fb67a345056e |
children | fe9222bf8b1d |
files | console/gntaccount.c console/gntaccount.h console/gntblist.c console/gntblist.h console/gntconn.c console/gntconn.h console/gntconv.c console/gntconv.h console/gntdebug.c console/gntdebug.h console/gntgaim.c console/gntgaim.h console/gntnotify.c console/gntnotify.h console/gntplugin.c console/gntplugin.h console/gntprefs.c console/gntprefs.h console/gntrequest.c console/gntrequest.h console/gntstatus.c console/gntstatus.h console/gntui.c console/gntui.h |
diffstat | 24 files changed, 779 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/console/gntaccount.c Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntaccount.c Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,27 @@ +/** + * @file gntaccount.c GNT Account 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 + */ #include <gnt.h> #include <gntbox.h> #include <gntbutton.h>
--- a/console/gntaccount.h Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntaccount.h Fri Sep 15 01:21:53 2006 +0000 @@ -1,14 +1,59 @@ +/** + * @file gntaccount.h GNT Account 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_ACCOUNT_H #define _GNT_ACCOUNT_H #include "account.h" +/********************************************************************** + * @name GNT Account API + **********************************************************************/ +/*@{*/ + +/** + * Get the ui-functions. + * + * @return The GaimAccountUiOps structure populated with the appropriate functions. + */ GaimAccountUiOps *gg_accounts_get_ui_ops(void); +/** + * Perform necessary initializations. + */ void gg_accounts_init(void); +/** + * Perform necessary uninitializations. + */ void gg_accounts_uninit(void); +/** + * Show the account-manager dialog. + */ void gg_accounts_show_all(void); +/*@}*/ + #endif
--- a/console/gntblist.c Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntblist.c Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,27 @@ +/** + * @file gntblist.c GNT BuddyList 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 + */ #include <account.h> #include <blist.h> #include <notify.h>
--- a/console/gntblist.h Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntblist.h Fri Sep 15 01:21:53 2006 +0000 @@ -1,22 +1,95 @@ +/** + * @file gntblist.h GNT BuddyList 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_BLIST_H #define _GNT_BLIST_H #include "blist.h" +/********************************************************************** + * @name GNT BuddyList API + **********************************************************************/ +/*@{*/ + +/** + * Get the ui-functions. + * + * @return The GaimBlistUiOps structure populated with the appropriate functions. + */ GaimBlistUiOps * gg_blist_get_ui_ops(void); +/** + * Perform necessary initializations. + */ void gg_blist_init(void); +/** + * Perform necessary uninitializations. + */ void gg_blist_uninit(void); +/** + * Show the buddy list. + */ void gg_blist_show(void); +/** + * Get the position of the buddy list. + * + * @param x The x-coordinate is set here if not @ NULL. + * @param y The y-coordinate is set here if not @c NULL. + * + * @return Returns @c TRUE if the values were set, @c FALSE otherwise. + */ gboolean gg_blist_get_position(int *x, int *y); +/** + * Set the position of the buddy list. + * + * @param x The x-coordinate of the buddy list. + * @param y The y-coordinate of the buddy list. + */ void gg_blist_set_position(int x, int y); +/** + * Get the size of the buddy list. + * + * @param width The width is set here if not @ NULL. + * @param height The height is set here if not @c NULL. + * + * @return Returns @c TRUE if the values were set, @c FALSE otherwise. + */ gboolean gg_blist_get_size(int *width, int *height); +/** + * Set the size of the buddy list. + * + * @param width The width of the buddy list. + * @param height The height of the buddy list. + */ void gg_blist_set_size(int width, int height); +/*@}*/ + #endif
--- a/console/gntconn.c Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntconn.c Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,27 @@ +/** + * @file gntconn.c GNT Connection 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 + */ #include "notify.h" #include "gntconn.h"
--- a/console/gntconn.h Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntconn.h Fri Sep 15 01:21:53 2006 +0000 @@ -1,12 +1,54 @@ +/** + * @file gntconn.h GNT Connection 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_CONN_H #define _GNT_CONN_H #include "connection.h" +/********************************************************************** + * @name GNT Connection API + **********************************************************************/ +/*@{*/ + +/** + * Get the ui-functions. + * + * @return The GaimConnectionUiOps structure populated with the appropriate functions. + */ GaimConnectionUiOps *gg_connections_get_ui_ops(void); +/** + * Perform necessary initializations. + */ void gg_connections_init(void); +/** + * Perform necessary uninitializations. + */ void gg_connections_uninit(void); +/*@}*/ + #endif
--- a/console/gntconv.c Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntconv.c Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,27 @@ +/** + * @file gntconv.c GNT Conversation 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 + */ #include <string.h> #include <cmds.h>
--- a/console/gntconv.h Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntconv.h Fri Sep 15 01:21:53 2006 +0000 @@ -1,15 +1,61 @@ +/** + * @file gntconv.h GNT Conversation 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_CONV_H #define _GNT_CONV_H #include "conversation.h" +/*************************************************************************** + * @name GNT Conversations API + ***************************************************************************/ +/*@{*/ + +/** + * Get the ui-functions. + * + * @return The GaimConversationUiOps populated with the appropriate functions. + */ GaimConversationUiOps *gg_conv_get_ui_ops(void); +/** + * Perform the necessary initializations. + */ void gg_conversation_init(void); +/** + * Perform the necessary uninitializations. + */ void gg_conversation_uninit(void); -/* Set a conversation as active in a contactized conversation */ +/** + * Set a conversation as active in a contactized conversation + * + * @param conv The conversation to make active. + */ void gg_conversation_set_active(GaimConversation *conv); +/*@}*/ + #endif
--- a/console/gntdebug.c Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntdebug.c Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,27 @@ +/** + * @file gntdebug.c 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 + */ #include <gnt.h> #include <gntbox.h> #include <gnttextview.h>
--- a/console/gntdebug.h Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntdebug.h Fri Sep 15 01:21:53 2006 +0000 @@ -1,14 +1,59 @@ +/** + * @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
--- a/console/gntgaim.c Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntgaim.c Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,24 @@ +/** + * 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 + */ #include "account.h" #include "conversation.h" #include "core.h"
--- a/console/gntgaim.h Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntgaim.h Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,24 @@ +/** + * 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 + */ #include <glib.h> #include "libgaim/internal.h"
--- a/console/gntnotify.c Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntnotify.c Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,27 @@ +/** + * @file gntnotify.c GNT Notify 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 + */ #include <gnt.h> #include <gntbox.h> #include <gntbutton.h>
--- a/console/gntnotify.h Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntnotify.h Fri Sep 15 01:21:53 2006 +0000 @@ -1,13 +1,55 @@ +/** + * @file gntnotify.h GNT Notify 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_NOTIFY_H #define _GNT_NOTIFY_H #include "notify.h" +/********************************************************************** + * @name GNT Notify API + **********************************************************************/ +/*@{*/ + +/** + * Get the ui-functions. + * + * @return The GaimNotifyUiOps structure populated with the appropriate functions. + */ GaimNotifyUiOps *gg_notify_get_ui_ops(void); +/** + * Perform necessary initializations. + */ void gg_notify_init(void); +/** + * Perform necessary uninitializations. + */ void gg_notify_uninit(void); +/*@}*/ + #endif
--- a/console/gntplugin.c Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntplugin.c Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,27 @@ +/** + * @file gntplugin.c GNT Plugins 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 + */ #include <gnt.h> #include <gntbox.h> #include <gntbutton.h>
--- a/console/gntplugin.h Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntplugin.h Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,27 @@ +/** + * @file gntplugin.h GNT Plugins 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_PLUGIN_H #define _GNT_PLUGIN_H @@ -7,20 +31,39 @@ #include <string.h> +/********************************************************************** + * @name GNT Plugins API + **********************************************************************/ +/*@{*/ + typedef GntWidget* (*GGPluginFrame) (); /* Guess where these came from */ #define GAIM_GNT_PLUGIN_TYPE "gnt" +/** + * Decide whether a plugin is a GNT-plugin. + */ #define GAIM_IS_GNT_PLUGIN(plugin) \ ((plugin)->info != NULL && (plugin)->info->ui_info != NULL && \ !strcmp((plugin)->info->ui_requirement, GAIM_GNT_PLUGIN_TYPE)) +/** + * Get the ui-info from GNT-plugins. + */ #define GAIM_GNT_PLUGIN_UI_INFO(plugin) \ (GGPluginFrame)((plugin)->info->ui_info) +/** + * Show a list of plugins. + */ void gg_plugins_show_all(void); +/** + * Save the list of loaded plugins. + */ void gg_plugins_save_loaded(void); +/*@}*/ + #endif
--- a/console/gntprefs.c Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntprefs.c Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,27 @@ +/** + * @file gntprefs.c GNT Preferences 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 + */ #include <prefs.h> #include "gntgaim.h"
--- a/console/gntprefs.h Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntprefs.h Fri Sep 15 01:21:53 2006 +0000 @@ -1,8 +1,45 @@ +/** + * @file gntprefs.h GNT Preferences 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_PREFS_H #define _GNT_PREFS_H +/********************************************************************** + * @name GNT Preferences API + **********************************************************************/ +/*@{*/ + +/** + * Perform necessary initializations. + */ void gg_prefs_init(void); +/** + * Show the preferences dialog. + */ void gg_prefs_show_all(void); +/*@}*/ + #endif
--- a/console/gntrequest.c Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntrequest.c Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,27 @@ +/** + * @file gntrequest.c GNT Request 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 + */ #include <gnt.h> #include <gntbox.h> #include <gntbutton.h>
--- a/console/gntrequest.h Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntrequest.h Fri Sep 15 01:21:53 2006 +0000 @@ -1,12 +1,54 @@ +/** + * @file gntrequest.h GNT Request 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_REQUEST_H #define _GNT_REQUEST_H #include "request.h" +/********************************************************************** + * @name GNT Request API + **********************************************************************/ +/*@{*/ + +/** + * Get the ui-functions. + * + * @return The GaimRequestUiOps structure populated with the appropriate functions. + */ GaimRequestUiOps *gg_request_get_ui_ops(void); +/** + * Perform necessary initializations. + */ void gg_request_init(void); +/** + * Perform necessary uninitializations. + */ void gg_request_uninit(void); +/*@}*/ + #endif
--- a/console/gntstatus.c Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntstatus.c Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,27 @@ +/** + * @file gntstatus.c GNT Status 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 + */ #include <gnt.h> #include <gntbox.h> #include <gntbutton.h>
--- a/console/gntstatus.h Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntstatus.h Fri Sep 15 01:21:53 2006 +0000 @@ -1,11 +1,50 @@ +/** + * @file gntstatus.h GNT Status 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_STATUS_H #define _GNT_STATUS_H #include <status.h> #include <savedstatuses.h> +/********************************************************************** + * @name GNT BuddyList API + **********************************************************************/ +/*@{*/ + +/** + * Show a dialog with all the saved statuses. + */ void gg_savedstatus_show_all(void); +/** + * Show a dialog to edit a status. + * + * @param saved The saved status to edit. Set it to @c NULL to create a new status. + */ void gg_savedstatus_edit(GaimSavedStatus *saved); +/*@}*/ + #endif
--- a/console/gntui.c Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntui.c Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,24 @@ +/** + * 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 + */ #include "gntui.h" #include "gntaccount.h"
--- a/console/gntui.h Thu Sep 14 22:21:52 2006 +0000 +++ b/console/gntui.h Fri Sep 15 01:21:53 2006 +0000 @@ -1,3 +1,24 @@ +/** + * 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_UI_H #define _GNT_UI_H