Starting work on doxygen cleanup. Many things still to be done.

doc/doxygen.main

@@ -25,15 +25,17 @@
  *  - \ref compositor
  *  - \ref scripts
  *  - \ref gameengine
+ *  - \ref data
  *
  * \section GUI
  *  - \ref gui
- *  - \ref hotkeys
- *  - \ref toolbox
  *
- * \section Libraries and Wrappers
+ * \section libraries Libraries and Wrappers
- *  - GHOST API: \ref GHOST_C-api.h
+ *  - \ref GHOST
  *  - \ref imbuf
+ *  - \ref audaspace
+ *  - \ref DNA
+ *  - \ref RNA
  *
  * \section Miscellaneous
  *  - \ref undoc
@@ -46,10 +48,21 @@
 
 /** \defgroup render Rendering Module */
 /** \defgroup meshedit Mesh Editing Module */
-/** \defgroup texture Textureing */
+/** \defgroup texture Texturing */
 /** \defgroup compositor Compositing */
 /** \defgroup scripts Scripting */
 /** \defgroup gameengine Game Engine */
+/** \defgroup audaspace Audaspace */
+
+/** \defgroup data DNA and RNA */
+
+/** \defgroup GHOST GHOST API */
+/** \defgroup DNA sDNA
+ *  \ingroup data
+ */
+/** \defgroup RNA RNA
+ *  \ingroup data
+ */
 
 /** \defgroup gui GUI */
 /** \defgroup hotkeys Hotkeys
@@ -58,6 +71,9 @@
 /** \defgroup toolbox Toolbox
  *  \ingroup gui
  */
+/** \defgroup wm windowmanager
+ *  \ingroup gui
+ */
 
 /** \defgroup imbuf IMage Buffer */
 /** \defgroup undoc Undocumented */

intern/ghost/GHOST_C-api.h

@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
@@ -25,10 +25,10 @@
  *
  * ***** END GPL LICENSE BLOCK *****
  */
-/**
+/*! \ingroup GHOST
- * @file	GHOST_C-api.h
+ *
+ * \file	GHOST_C-api.h
  * GHOST C-API function and type declarations.
- * The C-API wraps the C++ objects with the 
  */
 
 #ifndef	GHOST_C_API_H
@@ -44,7 +44,7 @@ extern "C" {
  * Creates a "handle" for a C++ GHOST object.
  * A handle is just an opaque pointer to an empty struct.
  * In the API the pointer is casted to the actual C++ class.
- * @param	name	Name of the handle to create.
+ * \param	name	Name of the handle to create.
  */
 
 GHOST_DECLARE_HANDLE(GHOST_SystemHandle);

intern/ghost/GHOST_ISystem.h

@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
@@ -25,9 +25,9 @@
  *
  * ***** END GPL LICENSE BLOCK *****
  */
-/**
+/*! \ingroup GHOST
- * @file	GHOST_ISystem.h
+ * \file	GHOST_ISystem.h
- * Main interface file for C++ Api with declaration of GHOST_ISystem interface
+ * %Main interface file for C++ Api with declaration of GHOST_ISystem interface
  * class.
  * Contains the doxygen documentation main page.
  */
@@ -42,7 +42,7 @@
 class GHOST_IEventConsumer;
 
 /**
- *! \mainpage GHOST Main Page
+ * \page GHOST GHOST
  *
  * \section intro Introduction
  *
@@ -115,7 +115,7 @@ class GHOST_IEventConsumer;
  * setting to turn menu functionality on or off.
  */
  
-/**
+/** \interface GHOST_ISystem
  * Interface for classes that provide access to the operating system.
  * There should be only one system class in an application.
  * Therefore, the routines to create and dispose the system are static.

intern/ghost/intern/GHOST_C-api.cpp

@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  * ***** BEGIN GPL LICENSE BLOCK *****
  *

source/blender/imbuf/IMB_imbuf.h

@@ -1,43 +1,3 @@
-/**
- * @file IMB_imbuf.h
- * @brief IMage Buffer module.
- *
- * This module offers import/export of several graphical file formats.
- * \ref IMB
- * @ingroup imbuf
- * @ingroup undoc
- *
- * @page IMB - Imbuf module external interface
- *
- *
- * @section about About the IMB module
- *
- * External interface of the IMage Buffer module. This module offers
- * import/export of several graphical file formats. It offers the
- * ImBuf type as a common structure to refer to different graphical
- * file formats, and to enable a uniform way of handling them.
- *
- * @section issues Known issues with IMB
- *
- * - imbuf is written in C.
- * - Endianness issues are dealt with internally.
- * - File I/O must be done externally. The module uses FILE*'s to
- *   direct input/output.
- * - Platform dependency is limited. Some minor patches for
- *   amiga and Irix are present. A 'posix-compliancy-patch'
- *   provides the interface to windows.
- *
- * @section dependencies Dependencies
- *
- * IMB needs:
- * - SDNA module
- *     The listbase types are used for handling the memory
- *     management.
- * - blenlib module
- *     blenlib handles guarded memory management in blender-style.
- *     BLI_winstuff.h makes a few windows specific behaviours
- *     posix-compliant.
- */
 /*
  * $Id$ 
  *
@@ -66,6 +26,44 @@
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+/**
+ * @file IMB_imbuf.h
+ * @brief IMage Buffer module.
+ *
+ * This module offers import/export of several graphical file formats.
+ * @ingroup imbuf
+ *
+ * @page IMB Imbuf module external interface
+ *
+ *
+ * @section about About the IMB module
+ *
+ * External interface of the IMage Buffer module. This module offers
+ * import/export of several graphical file formats. It offers the
+ * ImBuf type as a common structure to refer to different graphical
+ * file formats, and to enable a uniform way of handling them.
+ *
+ * @section issues Known issues with IMB
+ *
+ * - imbuf is written in C.
+ * - Endianness issues are dealt with internally.
+ * - File I/O must be done externally. The module uses FILE*'s to
+ *   direct input/output.
+ * - Platform dependency is limited. Some minor patches for
+ *   amiga and Irix are present. A 'posix-compliancy-patch'
+ *   provides the interface to windows.
+ *
+ * @section dependencies Dependencies
+ *
+ * IMB needs:
+ * - \ref DNA module
+ *     The listbase types are used for handling the memory
+ *     management.
+ * - \ref blenlib module
+ *     blenlib handles guarded memory management in blender-style.
+ *     BLI_winstuff.h makes a few windows specific behaviours
+ *     posix-compliant.
+ */
 
 #ifndef IMB_IMBUF_H
 #define IMB_IMBUF_H

source/blender/imbuf/IMB_imbuf_types.h

@@ -1,4 +1,4 @@
-/**
+/*
  * IMB_imbuf_types.h (mar-2001 nzc)
  *
  * Types needed for using the image buffer.
@@ -54,7 +54,6 @@ struct ImMetaData;
 #define IB_FILENAME_SIZE	1023
 
 /**
- * \brief The basic imbuf type
  * \ingroup imbuf
  * This is the abstraction of an image.  ImBuf is the basic type used for all
  * imbuf operations.

source/blender/makesdna/DNA_action_types.h

@@ -27,6 +27,10 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file DNA_action_types.h
+ *  \ingroup DNA
+ */
+
 
 #ifndef DNA_ACTION_TYPES_H
 #define DNA_ACTION_TYPES_H

source/blender/makesdna/DNA_actuator_types.h

@@ -1,6 +1,4 @@
-/**
+/*
- * blenlib/DNA_actuator_types.h (mar-2001 nzc)
- *	
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
@@ -28,6 +26,11 @@
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file DNA_actuator_types.h
+ *  \ingroup DNA
+ */
+
 #ifndef DNA_ACTUATOR_TYPES_H
 #define DNA_ACTUATOR_TYPES_H
 
@@ -227,19 +230,19 @@ typedef struct bActuator {
 	struct bActuator *next, *prev, *mynew;
 	short type;
 	/**
-	 * Tells what type of actuator data <data> holds. 
+	 * Tells what type of actuator data \ref data holds. 
 	 */
 	short flag;
 	short otype, go;
 	char name[32];
 
 	/**
-	 * Data must point to an object actuator type struct.
+	 * \var Data must point to an object actuator type struct.
 	 */
 	void *data;
 
 	/**
-	 * For ipo's and props: to find out which object the actuator
+	 * \var For ipo's and props: to find out which object the actuator
 	 * belongs to */
 	struct Object *ob;		
 	

source/blender/makesdna/DNA_customdata_types.h

@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** @file DNA_customdata_types.h
+ *  \ingroup DNA
+ */
+
 #ifndef DNA_CUSTOMDATA_TYPES_H
 #define DNA_CUSTOMDATA_TYPES_H
 
@@ -34,7 +38,7 @@
 extern "C" {
 #endif
 
-/* descriptor and storage for a custom data layer */
+/** descriptor and storage for a custom data layer */
 typedef struct CustomDataLayer {
 	int type;       /* type of data in layer */
 	int offset;     /* in editmode, offset of layer in block */
@@ -52,7 +56,7 @@ typedef struct CustomDataExternal {
 	char filename[240]; /* FILE_MAX */
 } CustomDataExternal;
 
-/* structure which stores custom element data associated with mesh elements
+/** structure which stores custom element data associated with mesh elements
  * (vertices, edges or faces). The custom data is organised into a series of
  * layers, each with a data type (e.g. MTFace, MDeformVert, etc.). */
 typedef struct CustomData {

source/blender/makesdna/DNA_documentation.h

@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
@@ -25,29 +25,32 @@
  * Contributor(s): none yet.
  *
  * ***** END GPL LICENSE BLOCK *****
+ */
+
+/*!
+ *  \ingroup DNA
+ *  \page makesdna makesdna
  *
- * @mainpage DNA- Makesdna modules 
+ * @section aboutdna About the DNA module
- *
- * @section about About the DNA module
  *
  * The DNA module holds all type definitions that are serialized in a
  * blender file. There is an executable that scans all files, looking
- * for struct-s to serialize (hence sdna: Struct DNA). From this
+ * for struct-s to serialize (hence sdna: Struct \ref DNA). From this
  * information, it builds a file with numbers that encode the format,
  * the names of variables, and the plce to look for them.
  *
- * @section issues Known issues with DNA
+ * @section dnaissues Known issues with DNA
  *
  * - Function pointers:
  *
  *   Because of historical reasons, some function pointers were
  *   untyped. The parser/dna generator has been modified to explicitly
  *   handle these special cases. Most pointers have been given proper
- *   proto's by now. DNA_space_types.h::Spacefile::returnfuncmay still
+ *   proto's by now. DNA_space_types.h::Spacefile::returnfunc may still
  *   be badly defined. The reason for this is that it is called with
  *   different types of arguments. It takes a char* at this moment...
  *
- * - Path to the header files
+ * - %Path to the header files
  *
  *   Also because of historical reasons, there is a path prefix to the
  *   headers that need to be scanned. This is the BASE_HEADER
@@ -55,20 +58,19 @@
  *   have to change this (Not very flexible, but it is hardly ever
  *   changed. Sorry.).
  *
- * @section dependencies Dependencies
+ * @section dnadependencies Dependencies
  *
  * DNA has no external dependencies (except for a few system
  * includes).
- *
- **/
 
+ * @section dnanote NOTE
 
-/* PLEASE READ INSTRUCTIONS ABOUT ADDING VARIABLES IN 'DNA' STRUCTS IN
+  PLEASE READ INSTRUCTIONS ABOUT ADDING VARIABLES IN 'DNA' STRUCTS IN
 
   intern/dna_genfile.c
   (ton)
 
- */
+ **/
 
 
 

source/blender/makesdna/intern/makesdna.c

@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
@@ -25,8 +25,9 @@
  * Contributor(s): none yet.
  *
  * ***** END GPL LICENSE BLOCK *****
- *
+ */
- * Struct muncher for making SDNA
+
+/** Struct muncher for making SDNA
  *
  * Originally by Ton, some mods by Frank, and some cleaning and
  * extension by Nzc.
@@ -160,12 +161,15 @@ int additional_slen_offset;
 /* ************************************************************************** */
 
 /**
- * Add type <str> to struct indexed by <len>, if it was not yet found.
+ * Add type \c str to struct indexed by \c len, if it was not yet found.
+ * \param str char
+ * \param len int
  */
 int add_type(const char *str, int len);
 
 /**
- * Add variable <str> to 
+ * Add variable \c str to 
+ * \param str
  */
 int add_name(char *str);
 

source/blender/makesrna/RNA_access.h

@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
@@ -25,6 +25,10 @@
 #ifndef RNA_ACCESS_H
 #define RNA_ACCESS_H
 
+/** \file RNA_access.h
+ *  \ingroup RNA
+ */
+
 #include <stdarg.h>
 
 #include "DNA_listBase.h"

source/blender/makesrna/RNA_define.h

@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
@@ -25,7 +25,9 @@
 #ifndef RNA_DEFINE_H
 #define RNA_DEFINE_H
 
-/* Functions used during preprocess and runtime, for defining the RNA. */
+/** \file RNA_define.h
+ *  \ingroup RNA
+ *  Functions used during preprocess and runtime, for defining the RNA. */
 
 #include <float.h>
 #include <limits.h>

source/blender/makesrna/RNA_enum_types.h

@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
@@ -25,6 +25,10 @@
 #ifndef RNA_ENUM_TYPES_H
 #define RNA_ENUM_TYPES_H
 
+/** \file RNA_enum_types.h
+ *  \ingroup RNA
+ */
+
 #include "RNA_types.h"
 
 /* Types */

source/blender/makesrna/intern/makesrna.c

@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****

source/blender/makesrna/intern/rna_internal.h

@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****

source/blender/windowmanager/WM_api.h

@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
@@ -28,6 +28,17 @@
 #ifndef WM_API_H
 #define WM_API_H
 
+/** \file WM_api.h
+ *  \ingroup wm
+ *
+ *  \page wmpage windowmanager
+ *  \section wmabout About windowmanager
+ *  \ref wm handles events received from \ref GHOST and manages
+ *  the screens, areas and input for Blender
+ *  \section wmnote NOTE
+ *  \todo document
+ */
+
 /* dna-savable wmStructs here */
 #include "DNA_windowmanager_types.h"