changeset 5034:4691c5936c01

[gaim-migrate @ 5377] More to recompile! Put some special Doxygen group tags in the documentation. I'm basically organizing it so when you do a make docs, you get a little Modules page showing "Gaim Core" and "GTK+ User Interface." This should make it easy for us to show which files belong in either category for now. This is kind of in preparation for all the core/ui split stuff I hope to start soon. committer: Tailor Script <tailor@pidgin.im>
author Christian Hammond <chipx86@chipx86.com>
date Sat, 05 Apr 2003 10:45:32 +0000
parents 14bbf22917d9
children 628681ec8a5e
files src/conversation.h src/core.h src/dnd-hints.h src/ft.h src/gtkconv.h src/gtkft.h src/gtkimhtml.h src/gtklist.h src/gtkpounce.h src/gtkutils.h src/list.h src/pounce.h src/proxy.h src/prpl.h src/sound.h src/stock.h src/ui.h src/util.h
diffstat 18 files changed, 30 insertions(+), 23 deletions(-) [+]
line wrap: on
line diff
--- a/src/conversation.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/conversation.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file conversation.h Conversation API
+ * @ingroup core
  *
  * gaim
  *
@@ -18,7 +19,6 @@
  * 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 _GAIM_CONVERSATION_H_
--- a/src/core.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/core.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,4 +1,7 @@
-/*
+/**
+ * @file core.h Gaim Core
+ * @defgroup core Gaim Core
+ *
  * gaim
  *
  * Copyright (C) 1998-1999, Mark Spencer <markster@marko.net>
@@ -16,7 +19,6 @@
  * 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 _CORE_H_
--- a/src/dnd-hints.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/dnd-hints.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file dnd-hints.h Drag-and-Drop arrow hints
+ * @ingroup gtkui
  *
  * Copyright (C) 2002-2003, Christian Hammond <chipx86@gnupdate.org>
  *
--- a/src/ft.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/ft.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file ft.h The file transfer interface
+ * @ingroup core
  *
  * gaim
  *
@@ -18,7 +19,6 @@
  * 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 _GAIM_FT_H_
 #define _GAIM_FT_H_
--- a/src/gtkconv.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/gtkconv.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file gtkconv.h GTK+ Conversation API
+ * @ingroup gtkui
  *
  * gaim
  *
@@ -18,7 +19,6 @@
  * 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 _GAIM_GTK_CONVERSATION_H_
--- a/src/gtkft.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/gtkft.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file gtkft.h The GTK+ file transfer UI
+ * @ingroup gtkui
  *
  * gaim
  *
@@ -18,7 +19,6 @@
  * 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 _GAIM_GTK_FT_H_
 #define _GAIM_GTK_FT_H_
--- a/src/gtkimhtml.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/gtkimhtml.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
-/*
- * GtkIMHtml
+/**
+ * @file gtkimhtml.h Gaim IM rendering component
+ * @ingroup gtkui
  *
  * Copyright (C) 2000, Eric Warmenhoven <warmenhoven@yahoo.com>
  *
@@ -16,7 +17,6 @@
  * 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 __GTK_IMHTML_H
--- a/src/gtklist.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/gtklist.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file gtklist.h GTK+ Buddy List API
+ * @ingroup gtkui
  *
  * gaim
  *
@@ -18,7 +19,6 @@
  * 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 _GAIM_GTK_LIST_H_
--- a/src/gtkpounce.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/gtkpounce.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file gtkpounce.h GTK+ buddy pounce API
+ * @ingroup gtkui
  *
  * gaim
  *
@@ -18,7 +19,6 @@
  * 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 _GAIM_GTK_POUNCE_H_
 #define _GAIM_GTK_POUNCE_H_
--- a/src/gtkutils.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/gtkutils.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file gtkutils.h GTK+ utility functions
+ * @ingroup gtkui
  *
  * gaim
  *
@@ -18,7 +19,6 @@
  * 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 _GAIM_GTK_UTILS_H_
--- a/src/list.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/list.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file list.h Buddy List API
+ * @ingroup core
  *
  * gaim
  *
@@ -18,7 +19,6 @@
  * 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
- *
  */
 
 /* I can't believe I let ChipX86 inspire me to write good code. -Sean */
@@ -346,8 +346,8 @@
 /**
  * Determines whether an account owns any buddies in a given group
  *
- * @param g  The group to search through.
- * @account  The account.
+ * @param g       The group to search through.
+ * @param account The account.
  */
 gboolean gaim_group_on_account(struct group *g, struct gaim_account *account);
 
--- a/src/pounce.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/pounce.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file pounce.h Buddy pounce API
+ * @ingroup core
  *
  * gaim
  *
@@ -18,7 +19,6 @@
  * 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 _GAIM_POUNCE_H_
 #define _GAIM_POUNCE_H_
--- a/src/proxy.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/proxy.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,4 +1,7 @@
-/*
+/**
+ * @file proxy.h Proxy functions
+ * @ingroup core
+ *
  * gaim
  *
  * Copyright (C) 1998-1999, Mark Spencer <markster@marko.net>
@@ -16,7 +19,6 @@
  * 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
- *
  */
 
 /* this is the export part of the proxy.c file. it does a little
--- a/src/prpl.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/prpl.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file prpl.h Protocol Plugin functions
+ * @ingroup core
  *
  * gaim
  *
@@ -18,7 +19,6 @@
  * 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
- *
  */
 
 /* this file should be all that prpls need to include. therefore, by including
--- a/src/sound.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/sound.h	Sat Apr 05 10:45:32 2003 +0000
@@ -18,7 +18,6 @@
  * 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 _GAIM_SOUND_H_
--- a/src/stock.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/stock.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file stock.h GTK+ Stock resources
+ * @ingroup gtkui
  *
  * gaim
  *
@@ -18,7 +19,6 @@
  * 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 _STOCK_H_
 #define _STOCK_H_
--- a/src/ui.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/ui.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,4 +1,7 @@
-/*
+/**
+ * @file ui.h Main GTK+ UI include file
+ * @defgroup gtkui GTK+ User Interface
+ *
  * gaim
  *
  * Copyright (C) 1998-1999, Mark Spencer <markster@marko.net>
@@ -16,7 +19,6 @@
  * 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 _UI_H_
--- a/src/util.h	Sat Apr 05 10:23:02 2003 +0000
+++ b/src/util.h	Sat Apr 05 10:45:32 2003 +0000
@@ -1,5 +1,6 @@
 /**
  * @file util.h Utility Functions
+ * @ingroup core
  *
  * gaim
  *