doxygen: blenkernel under core as module.
authorNathan Letwory <nathan@letworyinteractive.com>
Fri, 18 Feb 2011 13:05:18 +0000 (13:05 +0000)
committerNathan Letwory <nathan@letworyinteractive.com>
Fri, 18 Feb 2011 13:05:18 +0000 (13:05 +0000)
83 files changed:
doc/Doxyfile
doc/doxygen.main
source/blender/blenkernel/BKE_DerivedMesh.h
source/blender/blenkernel/BKE_action.h
source/blender/blenkernel/BKE_anim.h
source/blender/blenkernel/BKE_animsys.h
source/blender/blenkernel/BKE_armature.h
source/blender/blenkernel/BKE_array_mallocn.h
source/blender/blenkernel/BKE_blender.h
source/blender/blenkernel/BKE_bmesh.h
source/blender/blenkernel/BKE_bmeshCustomData.h
source/blender/blenkernel/BKE_bmfont.h
source/blender/blenkernel/BKE_bmfont_types.h
source/blender/blenkernel/BKE_boids.h
source/blender/blenkernel/BKE_booleanops_mesh.h
source/blender/blenkernel/BKE_brush.h
source/blender/blenkernel/BKE_bullet.h
source/blender/blenkernel/BKE_bvhutils.h
source/blender/blenkernel/BKE_cdderivedmesh.h
source/blender/blenkernel/BKE_cloth.h
source/blender/blenkernel/BKE_collision.h
source/blender/blenkernel/BKE_colortools.h
source/blender/blenkernel/BKE_constraint.h
source/blender/blenkernel/BKE_context.h
source/blender/blenkernel/BKE_curve.h
source/blender/blenkernel/BKE_customdata.h
source/blender/blenkernel/BKE_customdata_file.h
source/blender/blenkernel/BKE_deform.h
source/blender/blenkernel/BKE_depsgraph.h
source/blender/blenkernel/BKE_displist.h
source/blender/blenkernel/BKE_effect.h
source/blender/blenkernel/BKE_endian.h
source/blender/blenkernel/BKE_exotic.h
source/blender/blenkernel/BKE_fcurve.h
source/blender/blenkernel/BKE_fluidsim.h
source/blender/blenkernel/BKE_font.h
source/blender/blenkernel/BKE_global.h
source/blender/blenkernel/BKE_gpencil.h
source/blender/blenkernel/BKE_group.h
source/blender/blenkernel/BKE_icons.h
source/blender/blenkernel/BKE_idcode.h
source/blender/blenkernel/BKE_idprop.h
source/blender/blenkernel/BKE_image.h
source/blender/blenkernel/BKE_ipo.h
source/blender/blenkernel/BKE_key.h
source/blender/blenkernel/BKE_lattice.h
source/blender/blenkernel/BKE_library.h
source/blender/blenkernel/BKE_main.h
source/blender/blenkernel/BKE_material.h
source/blender/blenkernel/BKE_mball.h
source/blender/blenkernel/BKE_mesh.h
source/blender/blenkernel/BKE_modifier.h
source/blender/blenkernel/BKE_multires.h
source/blender/blenkernel/BKE_nla.h
source/blender/blenkernel/BKE_node.h
source/blender/blenkernel/BKE_object.h
source/blender/blenkernel/BKE_packedFile.h
source/blender/blenkernel/BKE_paint.h
source/blender/blenkernel/BKE_particle.h
source/blender/blenkernel/BKE_plugin_types.h
source/blender/blenkernel/BKE_pointcache.h
source/blender/blenkernel/BKE_property.h
source/blender/blenkernel/BKE_report.h
source/blender/blenkernel/BKE_sca.h
source/blender/blenkernel/BKE_scene.h
source/blender/blenkernel/BKE_screen.h
source/blender/blenkernel/BKE_script.h
source/blender/blenkernel/BKE_sequencer.h
source/blender/blenkernel/BKE_shrinkwrap.h
source/blender/blenkernel/BKE_sketch.h
source/blender/blenkernel/BKE_smoke.h
source/blender/blenkernel/BKE_softbody.h
source/blender/blenkernel/BKE_sound.h
source/blender/blenkernel/BKE_subsurf.h
source/blender/blenkernel/BKE_suggestions.h
source/blender/blenkernel/BKE_text.h
source/blender/blenkernel/BKE_texture.h
source/blender/blenkernel/BKE_unit.h
source/blender/blenkernel/BKE_utildefines.h
source/blender/blenkernel/BKE_world.h
source/blender/blenkernel/BKE_writeavi.h
source/blender/blenkernel/BKE_writeffmpeg.h
source/blender/blenkernel/BKE_writeframeserver.h

index 58622b3..0776736 100644 (file)
@@ -624,7 +624,8 @@ INPUT                  = doxygen.main \
                          ../source/blender/makesrna \
                          ../intern/ghost \
                          ../source/blender/blenloader \
-                         ../source/blender/readblenfile
+                         ../source/blender/readblenfile \
+                         ../source/blender/blenkernel
 
 # This tag can be used to specify the character encoding of the source files 
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
index c7db653..201596c 100644 (file)
  *  \todo add to doxygen
  */
 
+/** \defgroup core core */
+
+/** \defgroup bke blenkernel
+ *  \ingroup core
+ */
+
+/** \defgroup bli blenlib
+ *  \ingroup core
+ */
+
 /** \defgroup data DNA, RNA and .blend access*/
 
 /** \defgroup GHOST GHOST API */
index 1f56c16..857c88a 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_DERIVEDMESH_H
 #define BKE_DERIVEDMESH_H
 
-/* TODO (Probably)
+/** \file BKE_DerivedMesh.h
+ *  \ingroup bke
  *
- *  o Make drawMapped* functions take a predicate function that
+ *  \todo
+ *  - Make drawMapped* functions take a predicate function that
  *    determines whether to draw the edge (this predicate can
  *    also set color, etc). This will be slightly more general 
  *    and allow some of the functions to be collapsed.
- *  o Once accessor functions are added then single element draw
+ *  - Once accessor functions are added then single element draw
  *    functions can be implemented using primitive accessors.
- *  o Add function to dispatch to renderer instead of using
+ *  - Add function to dispatch to renderer instead of using
  *    conversion to DLM.
  */
 
index 1c75387..59da97d 100644 (file)
@@ -1,9 +1,4 @@
-/*  BKE_action.h   May 2001
- *  
- *  Blender kernel action and pose functionality
- *
- *     Reevan McKay
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 
 #ifndef BKE_ACTION_H
 #define BKE_ACTION_H
+/** \file BKE_action.h
+ *  \ingroup bke
+ *  \brief Blender kernel action and pose functionality.
+ *  \author Reevan McKay
+ *  \author Ton Roosendaal (full recode 2005)
+ *  \author Joshua Leung (full recode 2009)
+ *  \since may 2001
+ */
 
 #include "DNA_listBase.h"
 
index e82eb0e..25165ee 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_anim.h (mar-2001 nzc);
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_ANIM_H
 #define BKE_ANIM_H
 
+/** \file BKE_anim.h
+ *  \ingroup bke
+ *  \author nzc
+ *  \since March 2001
+ */
 struct Path;
 struct Object;
 struct PartEff;
index 500210d..a469d05 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_ANIM_SYS_H
 #define BKE_ANIM_SYS_H
 
+/** \file BKE_animsys.h
+ *  \ingroup bke
+ *  \author Joshua Leung
+ */
+
 struct ID;
 struct ListBase;
 struct Main;
index 5fb5dc4..efa8753 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_armature.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_ARMATURE_H
 #define BKE_ARMATURE_H
 
+/** \file BKE_armature.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
+
 struct Bone;
 struct Main;
 struct bArmature;
index 8fe32da..42c4c2e 100644 (file)
 #ifndef BKE_ARRAY_MALLOCN_H
 #define BKE_ARRAY_MALLOCN_H
 
-/*little array macro library.  example of usage:
+/** \file BKE_array_mallocn.h
+ *  \ingroup bke
+ *  \brief little array macro library.
+ */
+
+/* example of usage:
 
 int *arr = NULL;
 V_DECLARE(arr);
index 65e7f84..aa04e20 100644 (file)
@@ -1,8 +1,4 @@
-/**
- * blenlib/BKE_blender.h (mar-2001 nzc)
- *     
- * Blender util stuff?
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_BLENDER_H
 #define BKE_BLENDER_H
 
+/** \file BKE_blender.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ *  \brief Blender util stuff
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index 44ca384..5c28fa8 100644 (file)
@@ -1,8 +1,4 @@
-/**
- * BKE_bmesh.h    jan 2007
- *
- *     BMesh modeler structure and functions.
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_BMESH_H
 #define BKE_BMESH_H
 
+/** \file BKE_bmesh.h
+ *  \ingroup bke
+ *  \since January 2007
+ *  \brief BMesh modeler structure and functions.
+ *
+ */
+
 #include "DNA_listBase.h"
 #include "BLI_utildefines.h"
 #include "BLI_ghash.h"
index d2b7201..aabfcfa 100644 (file)
@@ -1,8 +1,4 @@
-/**
- * BKE_bmesh.h    jan 2007
- *
- *     BMesh modeler structure and functions.
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_BMESHCUSTOMDATA_H
 #define BKE_BMESHCUSTOMDATA_H
 
+/** \file BKE_bmeshCustomData.h
+ *  \ingroup bke
+ *  \since January 2007
+ *  \brief BMesh modeler structure and functions - custom data.
+ */
+
 struct BLI_mempool;
 
 /*Custom Data Types and defines
index 6a47dcb..ef7323f 100644 (file)
@@ -1,8 +1,4 @@
-/**
- * blenlib/BKE_bmfont.h (mar-2001 nzc)
- *
- *
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_BMFONT_H
 #define BKE_BMFONT_H
 
+/** \file BKE_bmfont.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index 77a618c..658302e 100644 (file)
@@ -1,8 +1,4 @@
-/**
- * blenlib/BKE_bmfont_types.h (mar-2001 nzc)
- *
- *
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_BMFONT_TYPES_H
 #define BKE_BMFONT_TYPES_H
 
+/** \file BKE_bmfont_types.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
 #define is_power_of_two(N) ((N ^ (N - 1)) == (2 * N - 1))
 /*
 Moved to IMB_imbuf_types.h where it will live close to the ImBuf type.
index ffd803f..36ca0cd 100644 (file)
@@ -1,6 +1,4 @@
-/* BKE_particle.h
- *
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_BOIDS_H
 #define BKE_BOIDS_H
 
+/** \file BKE_boids.h
+ *  \ingroup bke
+ *  \since 2009
+ *  \author Janne Karhu
+ */
+
 #include "DNA_boid_types.h"
 
 typedef struct BoidBrainData {
index 7c2d619..aecd338 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_PyBooleanOps_h
 #define BKE_PyBooleanOps_h
 
+/** \file BKE_booleanops_mesh.h
+ *  \ingroup bke
+ */
+
 #include "CSG_BooleanOps.h"
 
 /**
index de6da98..a9d379e 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_BRUSH_H
 #define BKE_BRUSH_H
 
+/** \file BKE_brush.h
+ *  \ingroup bke
+ */
+
 struct ID;
 struct Brush;
 struct ImBuf;
index b695bdc..76358c4 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  *     
  * $Id$
  *
 #ifndef BKE_BULLET_H
 #define BKE_BULLET_H
 
+/** \file BKE_bullet.h
+ *  \ingroup bke
+ */
+
 struct BulletSoftBody;
 
 
index 975e649..2948771 100644 (file)
@@ -1,5 +1,4 @@
-/**
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_BVHUTILS_H
 #define BKE_BVHUTILS_H
 
+/** \file BKE_bvhutils.h
+ *  \ingroup bke
+ */
+
 #include "BLI_kdopbvh.h"
 #include "BLI_linklist.h"
 
index bff9f16..1edec2b 100644 (file)
 * ***** END GPL LICENSE BLOCK *****
 */ 
 
-/* CDDerivedMesh interface.
- * CDDerivedMesh (CD = Custom Data) is a DerivedMesh backend which stores
- * mesh elements (vertices, edges and faces) as layers of custom element data.
+/** \file BKE_cdderivedmesh.h
+ *  \ingroup bke
+ *  \section aboutcdderivedmesh CDDerivedMesh interface
+ *   CDDerivedMesh (CD = Custom Data) is a DerivedMesh backend which stores
+ *   mesh elements (vertices, edges and faces) as layers of custom element data.
  */
 
 #ifndef BKE_CDDERIVEDMESH_H
index 83af573..1ee51cd 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * BKE_cloth.h
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_CLOTH_H
 #define BKE_CLOTH_H
 
+/** \file BKE_cloth.h
+ *  \ingroup bke
+ *  \author Daniel Genrich
+ */
+
 #include <float.h>
 
 struct Object;
index 03d4800..b54d427 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * BKE_cloth.h
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_COLLISIONS_H
 #define BKE_COLLISIONS_H
 
+/** \file BKE_collision.h
+ *  \ingroup bke
+ *  \author Daniel Genrich
+ */
+
 #include <math.h>
 #include <float.h>
 #include <stdlib.h>
index e0ebedb..b370985 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_COLORTOOLS_H
 #define BKE_COLORTOOLS_H
 
+/** \file BKE_colortools.h
+ *  \ingroup bke
+ */
+
 struct CurveMapping;
 struct CurveMap;
 struct Scopes;
index d6e0075..7c0e705 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_CONSTRAINT_H
 #define BKE_CONSTRAINT_H
 
+/** \file BKE_constraint.h
+ *  \ingroup bke
+ *  \author Joshua Leung (major recode 2007)
+ */
+
 struct ID;
 struct bConstraint;
 struct bConstraintTarget;
index 3acc08a..7254536 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_CONTEXT_H
 #define BKE_CONTEXT_H
 
+/** \file BKE_context.h
+ *  \ingroup bke
+ */
+
 #include "DNA_listBase.h"
 #include "RNA_types.h"
 
index 8c652a1..f0c58e0 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_curve.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_CURVE_H
 #define BKE_CURVE_H
 
+/** \file BKE_curve.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
 struct Curve;
 struct ListBase;
 struct Object;
index e911832..c30100e 100644 (file)
 * ***** END GPL LICENSE BLOCK *****
 */ 
 
-/* CustomData interface, see also DNA_customdata_types.h. */
+/** \file BKE_customdata.h
+ *  \ingroup bke
+ *  \author Ben Batt
+ *  \brief CustomData interface, see also DNA_customdata_types.h.
+ */
 
 #ifndef BKE_CUSTOMDATA_H
 #define BKE_CUSTOMDATA_H
index 9bcef76..f97565f 100644 (file)
 #ifndef BKE_CUSTOMDATA_FILE_H
 #define BKE_CUSTOMDATA_FILE_H
 
+/** \file BKE_customdata_file.h
+ *  \ingroup bke
+ */
+
 #define CDF_TYPE_IMAGE 0
 #define CDF_TYPE_MESH  1
 
index eaabc57..a9ac201 100644 (file)
@@ -1,9 +1,4 @@
-/*  BKE_deform.h   June 2001
- *  
- *  support for deformation groups and hooks
- * 
- *     Reevan McKay et al
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_DEFORM_H
 #define BKE_DEFORM_H
 
+/** \file BKE_deform.h
+ *  \ingroup bke
+ *  \since June 2001
+ *  \author Reevan McKay et al
+ *  \brief support for deformation groups and hooks.
+ */
+
 struct Object;
 struct ListBase;
 struct bDeformGroup;
index 9195413..f78a957 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DEPSGRAPH_API
 #define DEPSGRAPH_API
 
+/** \file BKE_depsgraph.h
+ *  \ingroup bke
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index 01d3de1..766981a 100644 (file)
@@ -1,4 +1,3 @@
-/* display list (or rather multi purpose list) stuff */
 /* 
        $Id$
  *
 #ifndef BKE_DISPLIST_H
 #define BKE_DISPLIST_H
 
+/** \file BKE_displist.h
+ *  \ingroup bke
+ *  \brief display list (or rather multi purpose list) stuff.
+ */
 #include "DNA_customdata_types.h"
 #include "BKE_customdata.h"
 
index 99f5520..97ac711 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_effect.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_EFFECT_H
 #define BKE_EFFECT_H
 
+/** \file BKE_effect.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
 #include "DNA_modifier_types.h"
 
 struct Object;
index d61b81f..5647645 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  * Are we little or big endian?  From Harbison&Steele.
- * BKE_ENDIANNESS(a) returns 1 if big endian and returns 0 if little endian
  */
 #ifndef BKE_ENDIAN_H
 #define BKE_ENDIAN_H
 
+/** \file BKE_endian.h
+ *  \ingroup bke
+ */
+
+/**
+ * BKE_ENDIANNESS(a) returns 1 if big endian and returns 0 if little endian
+ */
 #define BKE_ENDIANNESS(a) {  \
        union {  \
                intptr_t l;  \
index ad59cd9..870dd7c 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  * Contributor(s): none yet.
  *
  * ***** END GPL LICENSE BLOCK *****
- * dxf/vrml/stl external file io function prototypes
  */
 
 #ifndef BKE_EXOTIC_H
 #define BKE_EXOTIC_H
 
+/** \file BKE_exotic.h
+ *  \ingroup bke
+ *  \brief dxf/vrml/stl external file io function prototypes.
+ *  \attention is this used still? Candidate for removal?
+ */
 struct Mesh;
 struct Scene;
 
index 5fbb7f3..f81acf4 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_FCURVE_H
 #define BKE_FCURVE_H
 
+/** \file BKE_fcurve.h
+ *  \ingroup bke
+ *  \author Joshua Leung
+ *  \since 2009
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index e730f4e..f6070cd 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
@@ -30,6 +30,9 @@
 #ifndef BKE_FLUIDSIM_H
 #define BKE_FLUIDSIM_H
 
+/** \file BKE_fluidsim.h
+ *  \ingroup bke
+ */
 
 struct Object;
 struct Scene;
index c47a0b2..7f4e7c2 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_vfont.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_VFONT_H
 #define BKE_VFONT_H
 
+/** \file BKE_font.h
+ *  \ingroup bke
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index d222fe8..d83e0e5 100644 (file)
@@ -1,10 +1,4 @@
-/**
- * blenlib/BKE_global.h (mar-2001 nzc)
- *
- * Global settings, handles, pointers. This is the root for finding
- * any data in Blender. This block is not serialized, but built anew
- * for every fresh Blender run.
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_GLOBAL_H
 #define BKE_GLOBAL_H
 
+/** \file BKE_global.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ *  \section aboutglobal Global settings
+ *   Global settings, handles, pointers. This is the root for finding
+ *   any data in Blender. This block is not serialized, but built anew
+ *   for every fresh Blender run.
+ */
 #include "DNA_listBase.h"
 
 #ifdef __cplusplus
index 898538c..4898bb2 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_GPENCIL_H
 #define BKE_GPENCIL_H
 
+/** \file BKE_gpencil.h
+ *  \ingroup bke
+ *  \author Joshua Leung
+ */
+
 struct ListBase;
 struct bGPdata;
 struct bGPDlayer;
index 767e3c9..e497f43 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_group.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_GROUP_H
 #define BKE_GROUP_H
 
+/** \file BKE_group.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
+
 struct Base;
 struct Group;
 struct GroupObject;
index 42cbd22..5404402 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
 * $Id$
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_ICONS_H
 #define BKE_ICONS_H
 
+/** \file BKE_icons.h
+ *  \ingroup bke
+ */
+
 /*
  Resizable Icons for Blender
 */
index b624e34..1b2b3d2 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_ID_INFO_H
 #define BKE_ID_INFO_H
 
+/** \file BKE_idcode.h
+ *  \ingroup bke
+ */
+
 /**
  * Convert an idcode into a name.
  * 
index 0ca5690..e71ad5c 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef _BKE_IDPROP_H
 #define _BKE_IDPROP_H
 
+/** \file BKE_idprop.h
+ *  \ingroup bke
+ *  \author Joseph Eagar
+ */
+
 #include "DNA_ID.h"
 
 struct IDProperty;
index 283badc..8f0ce8c 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_image.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_IMAGE_H
 #define BKE_IMAGE_H
 
+/** \file BKE_image.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index e700f26..ea98c22 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_ipo.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_IPO_H
 #define BKE_IPO_H
 
+/** \file BKE_ipo.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ *  \author Joshua Leung
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index d72dce3..c29320e 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_key.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_KEY_H
 #define BKE_KEY_H
 
+/** \file BKE_key.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
 struct Key;
 struct KeyBlock;
 struct ID;
index 4f405e7..2936338 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  * Contributor(s): none yet.
  *
  * ***** END GPL LICENSE BLOCK *****
- * june-2001 ton
  */
 
 #ifndef BKE_LATTICE_H
 #define BKE_LATTICE_H
 
+/** \file BKE_lattice.h
+ *  \ingroup bke
+ *  \author Ton Roosendaal
+ *  \since June 2001
+ */
+
 struct Lattice;
 struct Object;
 struct Scene;
index f956749..871a78b 100644 (file)
@@ -1,8 +1,4 @@
-/**
- * blenlib/BKE_library.h (mar-2001 nzc)
- *     
- * Library
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_LIBRARY_TYPES_H
 #define BKE_LIBRARY_TYPES_H
 
+/** \file BKE_library.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
 #ifdef __cplusplus
 extern "C" {
 #endif
index 74d4cf8..df6a304 100644 (file)
@@ -1,13 +1,4 @@
-/**
- * blenlib/BKE_main.h (mar-2001 nzc)
- *
- * Main is the root of the 'database' of a Blender context. All data
- * is stuffed into lists, and all these lists are knotted to here. A
- * Blender file is not much more but a binary dump of these
- * lists. This list of lists is not serialized itself.
- *
- * Oops... this should be a _types.h file.
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_MAIN_H
 #define BKE_MAIN_H
 
+/** \file BKE_main.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ *  \section aboutmain Main struct
+ * Main is the root of the 'database' of a Blender context. All data
+ * is stuffed into lists, and all these lists are knotted to here. A
+ * Blender file is not much more but a binary dump of these
+ * lists. This list of lists is not serialized itself.
+ *
+ * Oops... this should be a _types.h file.
+ *
+ */
 #include "DNA_listBase.h"
 
 #ifdef __cplusplus
index 16c99cd..523a67e 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  * Contributor(s): none yet.
  *
  * ***** END GPL LICENSE BLOCK *****
- * General operations, lookup, etc. for materials.
  */
 
 #ifndef BKE_MATERIAL_H
 #define BKE_MATERIAL_H
 
+/** \file BKE_material.h
+ *  \ingroup bke
+ *  \brief General operations, lookup, etc. for materials.
+ */
 #ifdef __cplusplus
 extern "C" {
 #endif
index 6f36c26..c4119e9 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_mball.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_MBALL_H
 #define BKE_MBALL_H
 
+/** \file BKE_mball.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
 struct MetaBall;
 struct Object;
 struct Scene;
index 02d52e1..0f5780e 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * blenlib/BKE_mesh.h (mar-2001 nzc)
  *     
  * $Id$ 
 #ifndef BKE_MESH_H
 #define BKE_MESH_H
 
+/** \file BKE_mesh.h
+ *  \ingroup bke
+ */
+
 /***/
 
 struct BoundBox;
index 5bef752..af625ae 100644 (file)
@@ -1,5 +1,4 @@
-/**
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_MODIFIER_H
 #define BKE_MODIFIER_H
 
+/** \file BKE_modifier.h
+ *  \ingroup bke
+ */
+
 #include "DNA_modifier_types.h"                /* needed for all enum typdefs */
 #include "BKE_customdata.h"
 
index de895eb..ea34ff4 100644 (file)
 #ifndef BKE_MULTIRES_H
 #define BKE_MULTIRES_H
 
+/** \file BKE_multires.h
+ *  \ingroup bke
+ */
+
 struct DerivedMesh;
 struct Mesh;
 struct MFace;
index 30bce61..0206756 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_NLA_H
 #define BKE_NLA_H
 
+/** \file BKE_nla.h
+ *  \ingroup bke
+ *  \author Joshua Leung (full recode)
+ */
+
 struct AnimData;
 struct NlaStrip;
 struct NlaTrack;
index 57d18f5..0896dfb 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_NODE_H
 #define BKE_NODE_H
 
+/** \file BKE_node.h
+ *  \ingroup bke
+ */
+
 /* not very important, but the stack solver likes to know a maximum */
 #define MAX_SOCKET     64
 
index 100b511..3d32ba5 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  * Contributor(s): none yet.
  *
  * ***** END GPL LICENSE BLOCK *****
- * General operations, lookup, etc. for blender objects.
  */
 
 #ifndef BKE_OBJECT_H
 #define BKE_OBJECT_H
 
+/** \file BKE_object.h
+ *  \ingroup bke
+ *  \brief General operations, lookup, etc. for blender objects.
+ */
 #ifdef __cplusplus
 extern "C" {
 #endif
index c3ab392..541c581 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_packedFile.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_PACKEDFILE_H
 #define BKE_PACKEDFILE_H
 
+/** \file BKE_packedFile.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
 #define RET_OK         0
 #define RET_ERROR      1
 
index 2203277..238c812 100644 (file)
 #ifndef BKE_PAINT_H
 #define BKE_PAINT_H
 
+/** \file BKE_paint.h
+ *  \ingroup bke
+ */
+
 #include "DNA_vec_types.h"
 
 struct Brush;
index bb32542..507adcc 100644 (file)
@@ -1,6 +1,4 @@
-/* BKE_particle.h
- *
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_PARTICLE_H
 #define BKE_PARTICLE_H
 
+/** \file BKE_particle.h
+ *  \ingroup bke
+ */
+
 #include "DNA_particle_types.h"
 #include "DNA_object_types.h"
 
index 0bb1400..a7842b5 100644 (file)
@@ -1,9 +1,4 @@
-/**
- * blenlib/BKE_plugin_types.h (mar-2001 nzc)
- *
- * Renderrecipe and scene decription. The fact that there is a
- * hierarchy here is a bit strange, and not desirable.
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_PLUGIN_TYPES_H
 #define BKE_PLUGIN_TYPES_H
 
+/** \file BKE_plugin_types.h
+ *  \ingroup bke
+ *  \author nzc
+ */
+
 struct ImBuf;
 
 typedef        int (*TexDoitold)(int stype, void *cast, float *texvec, float *dxt, float *dyt);
index e4623a3..346368a 100644 (file)
 #ifndef BKE_POINTCACHE_H
 #define BKE_POINTCACHE_H
 
+/** \file BKE_pointcache.h
+ *  \ingroup bke
+ */
+
 #include "DNA_ID.h"
 #include "DNA_object_force.h"
 #include "DNA_boid_types.h"
index 5fab97b..10014a4 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenkernel/BKE_property.h (mar-2001 nzc)
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_PROPERTY_H
 #define BKE_PROPERTY_H
 
+/** \file BKE_property.h
+ *  \ingroup bke
+ */
+
 struct bProperty;
 struct ListBase;
 struct Object;
index b84808a..397c964 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_REPORT_H
 #define BKE_REPORT_H
 
+/** \file BKE_report.h
+ *  \ingroup bke
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index a9238da..0db0b71 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_SCA_H
 #define BKE_SCA_H
 
+/** \file BKE_sca.h
+ *  \ingroup bke
+ */
+
 struct Text;
 struct bSensor;
 struct Object;
index 2337b95..ac85f91 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_scene.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_SCENE_H
 #define BKE_SCENE_H
 
+/** \file BKE_scene.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index 1254866..0a7d978 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_screen.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_SCREEN_H
 #define BKE_SCREEN_H
 
+/** \file BKE_screen.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
+
 struct ARegion;
 struct bContext;
 struct bContextDataResult;
index 4ea1ee6..304e46f 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_script.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_SCRIPT_H
 #define BKE_SCRIPT_H
 
+/** \file BKE_script.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ *  \author Willian P. Germano
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index 6f5fbf7..cc1d853 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_SEQUENCER_H
 #define BKE_SEQUENCER_H
 
+/** \file BKE_sequencer.h
+ *  \ingroup bke
+ */
+
 struct bContext;
 struct Editing;
 struct ImBuf;
index 6b8e786..937a46d 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * BKE_shrinkwrap.h
- *
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
 #ifndef BKE_SHRINKWRAP_H
 #define BKE_SHRINKWRAP_H
 
+/** \file BKE_shrinkwrap.h
+ *  \ingroup bke
+ */
+
 /* mesh util */
 
 //TODO: move this somewhere else
index a59464b..f42d733 100644 (file)
@@ -1,5 +1,4 @@
-/**
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_SKETCH_H
 #define BKE_SKETCH_H
 
+/** \file BKE_sketch.h
+ *  \ingroup bke
+ */
+
 typedef enum SK_PType
 {
        PT_CONTINUOUS,
index 396db60..16e5336 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * BKE_smoke.h
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_SMOKE_H_
 #define BKE_SMOKE_H_
 
+/** \file BKE_smoke.h
+ *  \ingroup bke
+ *  \author Daniel Genrich
+ */
+
 typedef float (*bresenham_callback) (float *result, float *input, int res[3], int *pixel, float *tRay, float correct);
 
 void smokeModifier_do(struct SmokeModifierData *smd, struct Scene *scene, struct Object *ob, struct DerivedMesh *dm);
index 738fe7d..6aea934 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * BKE_softbody.h
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_SOFTBODY_H
 #define BKE_SOFTBODY_H
 
+/** \file BKE_softbody.h
+ *  \ingroup bke
+ */
+
 struct Object;
 struct Scene;
 struct SoftBody;
index cf77049..c5fcea6 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * sound.h (mar-2001 nzc)
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_SOUND_H
 #define BKE_SOUND_H
 
+/** \file BKE_sound.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
+
 struct PackedFile;
 struct bSound;
 struct bContext;
index ef3ad3a..b82db85 100644 (file)
 #ifndef BKE_SUBSURF_H
 #define BKE_SUBSURF_H
 
+/** \file BKE_subsurf.h
+ *  \ingroup bke
+ */
+
 struct DMGridAdjacency;
 struct DMGridData;
 struct DerivedMesh;
index 9eb8897..e215cab 100644 (file)
@@ -1,4 +1,4 @@
-/**    
+/*     
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_SUGGESTIONS_H
 #define BKE_SUGGESTIONS_H
 
+/** \file BKE_suggestions.h
+ *  \ingroup bke
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index 5f55f8b..a6b98b8 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_text.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_TEXT_H
 #define BKE_TEXT_H
 
+/** \file BKE_text.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index da9f13e..e6a21ec 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_texture.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_TEXTURE_H
 #define BKE_TEXTURE_H
 
+/** \file BKE_texture.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index 5708766..0a3e56c 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
 #ifndef BKE_UNIT_H
 #define BKE_UNIT_H
 
+/** \file BKE_unit.h
+ *  \ingroup bke
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index fca6a8c..14e622c 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
 */
 
-/* This file shold contain blender format spesific macros
- * generic defines should go in BLI_utildefines.h */
+/** \file BKE_utildefines.h
+ *  \ingroup bke
+ *  \brief blender format spesific macros
+ *  \note generic defines should go in BLI_utildefines.h
+ */
+
 
 #ifndef BKE_UTILDEFINES_H
 #define BKE_UTILDEFINES_H
index 8c6da40..30780b8 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_world.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_WORLD_H
 #define BKE_WORLD_H
 
+/** \file BKE_world.h
+ *  \ingroup bke
+ *  \since March 2001
+ *  \author nzc
+ */
+
 struct World;
 
 void free_world(struct World *sc); 
index c7f26d9..19cc1ae 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef BKE_WRITEAVI_H
 #define BKE_WRITEAVI_H
 
+/** \file BKE_writeavi.h
+ *  \ingroup bke
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index 311676b..2b10f1b 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
 #ifndef BKE_WRITEFFMPEG_H
 #define BKE_WRITEFFMPEG_H
 
+/** \file BKE_writeffmpeg.h
+ *  \ingroup bke
+ */
+
 #ifdef WITH_FFMPEG
 
 #ifdef __cplusplus
index 036e0db..2117a23 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
 #ifndef BKE_WRITEFRAMESERVER_H
 #define BKE_WRITEFRAMESERVER_H
 
+/** \file BKE_writeframeserver.h
+ *  \ingroup bke
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif