so that's the right way to do groups and subgroups...

doc/quakeforge.dox.in

@@ -140,7 +140,7 @@ STRIP_FROM_PATH        = @top_srcdir@
 # to NO (the default) then the documentation will be excluded. 
 # Set it to YES to include the internal documentation.
 
-INTERNAL_DOCS          = NO
+INTERNAL_DOCS          = YES
 
 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
 # file names in lower case letters. If set to YES upper case letters are also 

include/QF/cbuf.h

@@ -32,10 +32,8 @@
 #ifndef __QF_cbuf_h
 #define __QF_cbuf_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup cbuf Command buffer management.
+	\ingroup utils
 */
 //@{
 
@@ -102,7 +100,6 @@ void Cbuf_Execute (cbuf_t *cbuf);
 void Cbuf_Execute_Stack (cbuf_t *cbuf);
 void Cbuf_Execute_Sets (cbuf_t *cbuf);
 
-//@}
 //@}
 
 #endif//__QF_cbuf_h

include/QF/checksum.h

@@ -29,9 +29,6 @@
 #ifndef __checksum_h
 #define __checksum_h
 
-/** \addtogroup utils */
-//@{
-
 /** \addtogroup crc
 */
 //@{
@@ -42,7 +39,6 @@ unsigned int Com_BlockChecksum (const void *buffer, int length);
 void Com_BlockFullChecksum (const void *buffer, int len, unsigned char *outbuf);
 byte	COM_BlockSequenceCRCByte (const byte *base, int length, int sequence);
 
-//@}
 //@}
 
 #endif // __checksum_h

include/QF/cmd.h

@@ -29,10 +29,8 @@
 #ifndef __QF_cmd_h
 #define __QF_cmd_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup cmd Command management.
+	\ingroup utils
 */
 //@{
 
@@ -73,7 +71,6 @@ void Cmd_Exec_File (struct cbuf_s *cbuf, const char *path, int qfs);
 extern struct cbuf_args_s *cmd_args;
 extern struct cvar_s *cmd_warncmd;
 
-//@}
 //@}
 
 #endif//__QF_cmd_h

include/QF/crc.h

@@ -29,10 +29,8 @@
 #ifndef __crc_h
 #define __crc_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup crc Checksum generation.
+	\ingroup utils
 */
 //@{
 
@@ -44,7 +42,6 @@ void CRC_ProcessBlock (byte *start, unsigned short *crcvalue, int count);
 unsigned short CRC_Value(unsigned short crcvalue);
 unsigned short CRC_Block (byte *start, int count);
 
-//@}
 //@}
 
 #endif // __crc_h

include/QF/cvar.h

@@ -29,10 +29,8 @@
 #ifndef __cvar_h
 #define __cvar_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup cvar Configuration variables
+	\ingroup utils
 */
 //@{
 
@@ -133,7 +131,6 @@ void Cvar_Shutdown (void);
 
 extern cvar_t	*cvar_vars;
 
-//@}
 //@}
 
 #endif // __cvar_h

include/QF/draw.h

@@ -30,12 +30,14 @@
 #define _DRAW_H
 
 /** \defgroup video Video Syb-sytem */
-//@{
 
-/** \defgroup video_renderer Renderer Sub-system */
+/** \defgroup video_renderer Renderer Sub-system
-//@{
+	\ingroup video
+*/
 
-/** \defgroup video_renderer_draw Generic draw functions */
+/** \defgroup video_renderer_draw Generic draw functions
+	\ingroup video_renderer
+*/
 //@{
 
 #include "QF/wad.h"
@@ -51,7 +53,7 @@ void Draw_Init (void);
 	smoothly scrolled off.
 	\param x	horizontal location of the top left corner of the character.
 	\param y	vertical location of the top left corner of the character.
-	\param chr	8 bit character to draw.
+	\param ch	8 bit character to draw.
 	\note		The character drawn is from the quake character set, which is
 				(by default) standard ascii for 0x20-0x7e (white). 0xa0-0xfe is
 				also standard ascii (brown). 0x01-0x1f and 0x80-0x9f are
@@ -147,7 +149,7 @@ void Draw_Fill (int x, int y, int w, int h, int c);
 	\param x	horizontal location of the upper left corner of the box
 	\param y	vertical location of the upper left corner of the box
 	\param width horizontal size in character cells of the region
-	\param height vertical size in character cells of the region
+	\param lines vertical size in character cells of the region
 	\param alpha transparency of the box
 */
 void Draw_TextBox (int x, int y, int width, int lines, byte alpha);
@@ -155,8 +157,11 @@ void Draw_TextBox (int x, int y, int width, int lines, byte alpha);
 /** Darken the screen.
 */
 void Draw_FadeScreen (void);
+//@}
 
-/** \defgroup video_renderer_draw_qpic QPic functions */
+/** \defgroup video_renderer_draw_qpic QPic functions
+	\ingroup video_renderer_draw
+*/
 //@{
 /** Clear out the cached qpic textures.
 */
@@ -194,13 +199,9 @@ void Draw_Pic (int x, int y, qpic_t *pic);
 	\param srcy	vertical qpic location of the upper left corner of the
 				sub-region
 	\param width horizontal size of the sub-region to be drawn
-	\param width vertical size of the sub-region to be drawn
+	\param height vertical size of the sub-region to be drawn
 */
 void Draw_SubPic(int x, int y, qpic_t *pic, int srcx, int srcy, int width, int height);
 //@}
 
-//@}
-//@}
-//@}
-
 #endif // _DRAW_H

include/QF/dstring.h

@@ -29,10 +29,8 @@
 #ifndef __dstring_h
 #define __dstring_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup dstring Dynamic Strings
+	\ingroup utils
 */
 //@{
 
@@ -157,7 +155,6 @@ int davsprintf (dstring_t *dstr, const char *fmt, va_list args);
 int dasprintf (dstring_t *dstr, const char *fmt, ...) __attribute__((format(printf,2,3)));
 //@}
 
-//@}
 //@}
 
 #endif // __dstring_h

include/QF/hash.h

@@ -29,10 +29,8 @@
 #ifndef __hash_h
 #define __hash_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup hash Hash tables
+	\ingroup utils
 */
 //@{
 
@@ -70,6 +68,7 @@ hashtab_t *Hash_NewTable (int tsize, const char *(*gk)(void*,void*),
 	be mixed with the non-element functions, but by default the results will
 	be undefined.
 
+	\param tab	the table configure
 	\param gh takes the same parameters as gk in Hash_NewTable
 	\param cmp is element 1, element 2, userdata
 */
@@ -104,14 +103,12 @@ int Hash_AddElement (hashtab_t *tab, void *ele);
 /** find an element within a hash table.
 	\param tab	the table to search
 	\param key	the key string identifying the element being searched for
-	\param ele	element with info identifying the element being searched for
 	\return		pointer to the element if found, otherwise 0.
 */
 void *Hash_Find (hashtab_t *tab, const char *key);
 
 /** find an element within a hash table.
 	\param tab	the table to search
-	\param key	the key string identifying the element being searched for
 	\param ele	element with info identifying the element being searched for
 	\return		pointer to the element if found, otherwise 0.
 */
@@ -210,7 +207,6 @@ void **Hash_GetList (hashtab_t *tab);
 */
 void Hash_Stats (hashtab_t *tab);
 
-//@}
 //@}
 
 #endif // __hash_h

include/QF/idparse.h

@@ -31,9 +31,6 @@
 #ifndef __QF_idparse_h
 #define __QF_idparse_h
 
-/** \addtogroup utils */
-//@{
-
 /** \addtogroup cbuf
 */
 //@{
@@ -47,7 +44,6 @@ void COM_TokenizeString (const char *str, struct cbuf_args_s *args);
 
 extern struct cbuf_interpreter_s id_interp;
 
-//@}
 //@}
 
 #endif//__QF_idparse_h

include/QF/info.h

@@ -29,10 +29,8 @@
 #ifndef _INFO_H
 #define _INFO_H
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup info Info Keys
+	\ingroup utils
 */
 //@{
 
@@ -67,7 +65,6 @@ void Info_Destroy (info_t *info);
 char *Info_MakeString (info_t *info, int (*filter)(const char *));
 void Info_AddKeys (info_t *info, info_t *keys);
 
-//@}
 //@}
 
 #endif	// _INFO_H

include/QF/mathlib.h

@@ -29,10 +29,8 @@
 #ifndef __mathlib_h
 #define __mathlib_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup mathlib Vector and matrix functions
+	\ingroup utils
 */
 //@{
 
@@ -319,7 +317,6 @@ VectorNormalize (vec3_t v)
 	return length;
 }
 
-//@}
 //@}
 
 #endif // __mathlib_h

include/QF/mdfour.h

@@ -30,9 +30,6 @@
 #ifndef __mdfour_h
 #define __mdfour_h
 
-/** \addtogroup utils */
-//@{
-
 /** \addtogroup crc
 */
 //@{
@@ -51,7 +48,6 @@ void mdfour_update(struct mdfour *md, const unsigned char *in, int n); //old: MD
 void mdfour_result(struct mdfour *md, unsigned char *out); // old: MD4Final
 void mdfour(unsigned char *out, const unsigned char *in, int n);
 
-//@}
 //@}
 
 #endif	// __mdfour_h

include/QF/msg.h

@@ -28,10 +28,8 @@
 #ifndef _MSG_H
 #define _MSG_H
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup msg Message reading and writing
+	\ingroup utils
 */
 //@{
 
@@ -76,7 +74,6 @@ void MSG_ReadAngleV (qmsg_t *msg, vec3_t angles);
 float MSG_ReadAngle16 (qmsg_t *msg);
 int MSG_ReadUTF8 (qmsg_t *msg);
 
-//@}
 //@}
 
 #endif

include/QF/pak.h

@@ -32,9 +32,6 @@
 #ifndef __qf_pak_h
 #define __qf_pak_h
 
-/** \addtogroup utils */
-//@{
-
 /** \addtogroup pak
 */
 //@{
@@ -52,7 +49,6 @@ typedef struct {
 	int			dirlen;
 } dpackheader_t;
 
-//@}
 //@}
 
 #endif//__qf_pak_h

include/QF/pakfile.h

@@ -31,10 +31,8 @@
 #ifndef __QF_pakfile_h
 #define __QF_pakfile_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup pak pakfile proccessing
+	\ingroup utils
 */
 //@{
 
@@ -67,7 +65,6 @@ int pack_add (pack_t *pack, const char *filename);
 int pack_extract (pack_t *pack, dpackfile_t *pf);
 dpackfile_t *pack_find_file (pack_t *pack, const char *filename);
 
-//@}
 //@}
 
 #endif//__QF_pakfile_h

include/QF/plugin.h

@@ -29,10 +29,8 @@
 #ifndef __QF_plugin_h_
 #define __QF_plugin_h_
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup plugin Plugins
+	\ingroup utils
 */
 //@{
 
@@ -117,7 +115,6 @@ void PI_Shutdown (void);
 
 // FIXME: we need a generic function to initialize unused fields
 
-//@}
 //@}
 
 #endif	// __QF_plugin_h_

include/QF/qargs.h

@@ -31,9 +31,6 @@
 #ifndef __qargs_h
 #define __qargs_h
 
-/** \addtogroup utils */
-//@{
-
 /** \addtogroup misc
 */
 //@{
@@ -51,7 +48,6 @@ void COM_Init (void);
 void COM_Init_Cvars (void);
 void COM_InitArgv (int argc, const char **argv);
 
-//@}
 //@}
 
 #endif // __qargs_h

include/QF/qendian.h

@@ -31,10 +31,8 @@
 #ifndef __qendian_h
 #define __qendian_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup qendian Endian handling functions
+	\ingroup utils
 */
 //@{
 
@@ -96,7 +94,6 @@ byte ReadByte (struct QFile_s *file);
 unsigned short ReadShort (struct QFile_s *file);
 unsigned int ReadLong (struct QFile_s *file);
 
-//@}
 //@}
 
 #endif // __qendian_h

include/QF/qfplist.h

@@ -29,10 +29,8 @@
 #ifndef __QF_qfplist_h_
 #define __QF_qfplist_h_
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup qfplist Property lists
+	\ingroup utils
 */
 //@{
 
@@ -250,7 +248,6 @@ typedef struct pldata_s {	// Unparsed property list string
 	const char		*error;
 } pldata_t;
 
-//@}
 //@}
 
 #endif	// __QF_qfplist_h_

include/QF/quakefs.h

@@ -31,10 +31,8 @@
 #ifndef __quakefs_h
 #define __quakefs_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup quakefs Quake Filesystem
+	\ingroup utils
 */
 //@{
 
@@ -132,7 +130,6 @@ void QFS_FilelistFree (filelist_t *list);
 // FIXME: This is here temporarily until fs_usercfg gets sorted out
 char *expand_squiggle (const char *path);
 
-//@}
 //@}
 
 #endif // __quakefs_h

include/QF/quakeio.h

@@ -32,10 +32,8 @@
 
 #include <stdio.h>
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup quakeio File IO
+	\ingroup utils
 */
 //@{
 
@@ -63,7 +61,6 @@ int Qflush(QFile *file);
 int Qeof(QFile *file);
 const char *Qgetline(QFile *file);
 
-//@}
 //@}
 
 #endif /*__quakeio_h*/

include/QF/script.h

@@ -20,10 +20,8 @@
 #ifndef __QF_script_h
 #define __QF_script_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup script Scripts
+	\ingroup utils
 	Line oriented script parsing. Multiple scripts being parsed at the same
 	time is supported.
 */
@@ -90,7 +88,6 @@ qboolean Script_GetToken (script_t *script, qboolean crossline);
 */
 void Script_UngetToken (script_t *script);
 
-//@}
 //@}
 
 #endif//__QF_script_h

include/QF/sizebuf.h

@@ -28,10 +28,8 @@
 #ifndef __sizebuf_h
 #define __sizebuf_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup sizebuf Fixed Size Buffers
+	\ingroup utils
 	Fixed size buffer management
 */
 //@{
@@ -54,7 +52,6 @@ void *SZ_GetSpace (sizebuf_t *buf, int length);
 void SZ_Write (sizebuf_t *buf, const void *data, int length);
 void SZ_Print (sizebuf_t *buf, const char *data);	// strcats onto the sizebuf
 
-//@}
 //@}
 
 #endif // __sizebuf_h

include/QF/sys.h

@@ -29,10 +29,8 @@
 #ifndef __sys_h
 #define __sys_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup sys Portability
+	\ingroup utils
 	Non-portable functions
 */
 //@{
@@ -114,6 +112,5 @@ void Sys_DebugLog(const char *file, const char *fmt, ...) __attribute__((format(
 	} while (0)
 
 //@}
-//@}
 
 #endif // __sys_h

include/QF/va.h

@@ -30,9 +30,6 @@
 #ifndef __va_h
 #define __va_h
 
-/** \addtogroup utils */
-//@{
-
 /** \addtogroup misc
 	Formatted printing.
 */
@@ -43,7 +40,6 @@ char	*va(const char *format, ...) __attribute__((format(printf,1,2)));
 // does a varargs printf into a malloced buffer
 char	*nva(const char *format, ...) __attribute__((format(printf,1,2)));
 
-//@}
 //@}
 
 #endif // __va_h

include/QF/ver_check.h

@@ -29,10 +29,10 @@
 #ifndef __ver_check_h_
 #define __ver_check_h_
 
-/** \addtogroup utils */
+/** \defgroup utils Utils
-//@{
 
-/** \addtogroup misc
+/** \defgroup misc Miscellaneous functions
+	\ingroup utils
 */
 //@{
 
@@ -45,7 +45,6 @@
 */
 int ver_compare (const char *, const char *);
 
-//@}
 //@}
 
 #endif	// __ver_check_h_

include/QF/wad.h

@@ -30,9 +30,6 @@
 #ifndef _WAD_H
 #define _WAD_H
 
-/** \addtogroup utils */
-//@{
-
 /** \addtogroup wad
 	Wad Files
 */
@@ -50,7 +47,6 @@ void	*W_GetLumpName (const char *name);
 
 void SwapPic (qpic_t *pic);
 
-//@}
 //@}
 
 #endif // _WAD_H

include/QF/wadfile.h

@@ -26,10 +26,8 @@
 	$Id$
 */
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup wad Wad Files
+	\ingroup utils
 	Wadfile processing
 */
 //@{
@@ -105,7 +103,6 @@ int wad_add_data (wad_t *wad, const char *lumpname, byte type,
 				  const void *data, int bytes);
 lumpinfo_t *wad_find_lump (wad_t *wad, const char *filename);
 
-//@}
 //@}
 
 #endif//__QF_wadfile_h

include/QF/zone.h

@@ -28,10 +28,8 @@
 #ifndef __zone_h
 #define __zone_h
 
-/** \addtogroup utils */
-//@{
-
 /** \defgroup zone Memory Management
+	\ingroup utils
 
 	H_??? The hunk manages the entire memory block given to quake.  It must be
 	contiguous.  Memory can be allocated from either the low or high end in a
@@ -174,7 +172,6 @@ void *QA_realloc (void *ptr, size_t size);
 void QA_free (void *ptr);
 char *QA_strdup (const char *s);
 
-//@}
 //@}
 
 #endif // __zone_h