diff options
Diffstat (limited to 'source')
81 files changed, 484 insertions, 197 deletions
diff --git a/source/blender/blenkernel/BKE_DerivedMesh.h b/source/blender/blenkernel/BKE_DerivedMesh.h index 1f56c164fcc..857c88a6004 100644 --- a/source/blender/blenkernel/BKE_DerivedMesh.h +++ b/source/blender/blenkernel/BKE_DerivedMesh.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,15 +30,17 @@ #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. */ diff --git a/source/blender/blenkernel/BKE_action.h b/source/blender/blenkernel/BKE_action.h index 1c75387ba5d..59da97d8b09 100644 --- a/source/blender/blenkernel/BKE_action.h +++ b/source/blender/blenkernel/BKE_action.h @@ -1,9 +1,4 @@ -/* BKE_action.h May 2001 - * - * Blender kernel action and pose functionality - * - * Reevan McKay - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -33,6 +28,14 @@ #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" diff --git a/source/blender/blenkernel/BKE_anim.h b/source/blender/blenkernel/BKE_anim.h index e82eb0ed0c9..25165eeaee7 100644 --- a/source/blender/blenkernel/BKE_anim.h +++ b/source/blender/blenkernel/BKE_anim.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_anim.h (mar-2001 nzc); - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,11 @@ #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; diff --git a/source/blender/blenkernel/BKE_animsys.h b/source/blender/blenkernel/BKE_animsys.h index 500210d2fcd..a469d05ee26 100644 --- a/source/blender/blenkernel/BKE_animsys.h +++ b/source/blender/blenkernel/BKE_animsys.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,6 +28,11 @@ #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; diff --git a/source/blender/blenkernel/BKE_armature.h b/source/blender/blenkernel/BKE_armature.h index 5fb5dc4969d..efa87532859 100644 --- a/source/blender/blenkernel/BKE_armature.h +++ b/source/blender/blenkernel/BKE_armature.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_armature.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,12 @@ #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; diff --git a/source/blender/blenkernel/BKE_array_mallocn.h b/source/blender/blenkernel/BKE_array_mallocn.h index 8fe32da437c..42c4c2ebdd0 100644 --- a/source/blender/blenkernel/BKE_array_mallocn.h +++ b/source/blender/blenkernel/BKE_array_mallocn.h @@ -30,7 +30,12 @@ #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); diff --git a/source/blender/blenkernel/BKE_blender.h b/source/blender/blenkernel/BKE_blender.h index 65e7f848ea0..aa04e20beb6 100644 --- a/source/blender/blenkernel/BKE_blender.h +++ b/source/blender/blenkernel/BKE_blender.h @@ -1,8 +1,4 @@ -/** - * blenlib/BKE_blender.h (mar-2001 nzc) - * - * Blender util stuff? - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -33,6 +29,13 @@ #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 diff --git a/source/blender/blenkernel/BKE_bmesh.h b/source/blender/blenkernel/BKE_bmesh.h index 44ca3842fd9..5c28fa88503 100644 --- a/source/blender/blenkernel/BKE_bmesh.h +++ b/source/blender/blenkernel/BKE_bmesh.h @@ -1,8 +1,4 @@ -/** - * BKE_bmesh.h jan 2007 - * - * BMesh modeler structure and functions. - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -37,6 +33,13 @@ #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" diff --git a/source/blender/blenkernel/BKE_bmeshCustomData.h b/source/blender/blenkernel/BKE_bmeshCustomData.h index d2b72019b68..aabfcfaa0f6 100644 --- a/source/blender/blenkernel/BKE_bmeshCustomData.h +++ b/source/blender/blenkernel/BKE_bmeshCustomData.h @@ -1,8 +1,4 @@ -/** - * BKE_bmesh.h jan 2007 - * - * BMesh modeler structure and functions. - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -38,6 +34,12 @@ #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 diff --git a/source/blender/blenkernel/BKE_bmfont.h b/source/blender/blenkernel/BKE_bmfont.h index 6a47dcbd6c4..ef7323fc4c3 100644 --- a/source/blender/blenkernel/BKE_bmfont.h +++ b/source/blender/blenkernel/BKE_bmfont.h @@ -1,8 +1,4 @@ -/** - * blenlib/BKE_bmfont.h (mar-2001 nzc) - * - * - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -33,6 +29,12 @@ #ifndef BKE_BMFONT_H #define BKE_BMFONT_H +/** \file BKE_bmfont.h + * \ingroup bke + * \since March 2001 + * \author nzc + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/blenkernel/BKE_bmfont_types.h b/source/blender/blenkernel/BKE_bmfont_types.h index 77a618c1be4..658302e9f1d 100644 --- a/source/blender/blenkernel/BKE_bmfont_types.h +++ b/source/blender/blenkernel/BKE_bmfont_types.h @@ -1,8 +1,4 @@ -/** - * blenlib/BKE_bmfont_types.h (mar-2001 nzc) - * - * - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -33,6 +29,11 @@ #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. diff --git a/source/blender/blenkernel/BKE_boids.h b/source/blender/blenkernel/BKE_boids.h index ffd803f21a5..36ca0cde87d 100644 --- a/source/blender/blenkernel/BKE_boids.h +++ b/source/blender/blenkernel/BKE_boids.h @@ -1,6 +1,4 @@ -/* BKE_particle.h - * - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -32,6 +30,12 @@ #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 { diff --git a/source/blender/blenkernel/BKE_booleanops_mesh.h b/source/blender/blenkernel/BKE_booleanops_mesh.h index 7c2d619659a..aecd3385662 100644 --- a/source/blender/blenkernel/BKE_booleanops_mesh.h +++ b/source/blender/blenkernel/BKE_booleanops_mesh.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +29,10 @@ #ifndef BKE_PyBooleanOps_h #define BKE_PyBooleanOps_h +/** \file BKE_booleanops_mesh.h + * \ingroup bke + */ + #include "CSG_BooleanOps.h" /** diff --git a/source/blender/blenkernel/BKE_brush.h b/source/blender/blenkernel/BKE_brush.h index de6da9883e1..a9d379e6c69 100644 --- a/source/blender/blenkernel/BKE_brush.h +++ b/source/blender/blenkernel/BKE_brush.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +31,10 @@ #ifndef BKE_BRUSH_H #define BKE_BRUSH_H +/** \file BKE_brush.h + * \ingroup bke + */ + struct ID; struct Brush; struct ImBuf; diff --git a/source/blender/blenkernel/BKE_bullet.h b/source/blender/blenkernel/BKE_bullet.h index b695bdc91ae..76358c4485b 100644 --- a/source/blender/blenkernel/BKE_bullet.h +++ b/source/blender/blenkernel/BKE_bullet.h @@ -1,4 +1,4 @@ -/** +/* * * $Id$ * @@ -30,6 +30,10 @@ #ifndef BKE_BULLET_H #define BKE_BULLET_H +/** \file BKE_bullet.h + * \ingroup bke + */ + struct BulletSoftBody; diff --git a/source/blender/blenkernel/BKE_bvhutils.h b/source/blender/blenkernel/BKE_bvhutils.h index 975e64929c2..29487713ad4 100644 --- a/source/blender/blenkernel/BKE_bvhutils.h +++ b/source/blender/blenkernel/BKE_bvhutils.h @@ -1,5 +1,4 @@ -/** - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +29,10 @@ #ifndef BKE_BVHUTILS_H #define BKE_BVHUTILS_H +/** \file BKE_bvhutils.h + * \ingroup bke + */ + #include "BLI_kdopbvh.h" #include "BLI_linklist.h" diff --git a/source/blender/blenkernel/BKE_cdderivedmesh.h b/source/blender/blenkernel/BKE_cdderivedmesh.h index bff9f16b489..1edec2b69d9 100644 --- a/source/blender/blenkernel/BKE_cdderivedmesh.h +++ b/source/blender/blenkernel/BKE_cdderivedmesh.h @@ -27,9 +27,11 @@ * ***** 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 diff --git a/source/blender/blenkernel/BKE_cloth.h b/source/blender/blenkernel/BKE_cloth.h index 83af573bd42..1ee51cd2122 100644 --- a/source/blender/blenkernel/BKE_cloth.h +++ b/source/blender/blenkernel/BKE_cloth.h @@ -1,6 +1,4 @@ -/** - * BKE_cloth.h - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,11 @@ #ifndef BKE_CLOTH_H #define BKE_CLOTH_H +/** \file BKE_cloth.h + * \ingroup bke + * \author Daniel Genrich + */ + #include <float.h> struct Object; diff --git a/source/blender/blenkernel/BKE_collision.h b/source/blender/blenkernel/BKE_collision.h index 03d4800076c..b54d4275719 100644 --- a/source/blender/blenkernel/BKE_collision.h +++ b/source/blender/blenkernel/BKE_collision.h @@ -1,6 +1,4 @@ -/** - * BKE_cloth.h - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,11 @@ #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> diff --git a/source/blender/blenkernel/BKE_colortools.h b/source/blender/blenkernel/BKE_colortools.h index e0ebedb320b..b3709853a8c 100644 --- a/source/blender/blenkernel/BKE_colortools.h +++ b/source/blender/blenkernel/BKE_colortools.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +29,10 @@ #ifndef BKE_COLORTOOLS_H #define BKE_COLORTOOLS_H +/** \file BKE_colortools.h + * \ingroup bke + */ + struct CurveMapping; struct CurveMap; struct Scopes; diff --git a/source/blender/blenkernel/BKE_constraint.h b/source/blender/blenkernel/BKE_constraint.h index d6e0075df1e..7c0e7050a9f 100644 --- a/source/blender/blenkernel/BKE_constraint.h +++ b/source/blender/blenkernel/BKE_constraint.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +30,11 @@ #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; diff --git a/source/blender/blenkernel/BKE_context.h b/source/blender/blenkernel/BKE_context.h index 3acc08a76b6..7254536b555 100644 --- a/source/blender/blenkernel/BKE_context.h +++ b/source/blender/blenkernel/BKE_context.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,6 +28,10 @@ #ifndef BKE_CONTEXT_H #define BKE_CONTEXT_H +/** \file BKE_context.h + * \ingroup bke + */ + #include "DNA_listBase.h" #include "RNA_types.h" diff --git a/source/blender/blenkernel/BKE_curve.h b/source/blender/blenkernel/BKE_curve.h index 8c652a11794..f0c58e0a511 100644 --- a/source/blender/blenkernel/BKE_curve.h +++ b/source/blender/blenkernel/BKE_curve.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_curve.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,11 @@ #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; diff --git a/source/blender/blenkernel/BKE_customdata.h b/source/blender/blenkernel/BKE_customdata.h index e9118323682..c30100ea55a 100644 --- a/source/blender/blenkernel/BKE_customdata.h +++ b/source/blender/blenkernel/BKE_customdata.h @@ -27,7 +27,11 @@ * ***** 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 diff --git a/source/blender/blenkernel/BKE_customdata_file.h b/source/blender/blenkernel/BKE_customdata_file.h index 9bcef7636c6..f97565f23a1 100644 --- a/source/blender/blenkernel/BKE_customdata_file.h +++ b/source/blender/blenkernel/BKE_customdata_file.h @@ -23,6 +23,10 @@ #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 diff --git a/source/blender/blenkernel/BKE_deform.h b/source/blender/blenkernel/BKE_deform.h index eaabc57c781..a9ac201beda 100644 --- a/source/blender/blenkernel/BKE_deform.h +++ b/source/blender/blenkernel/BKE_deform.h @@ -1,9 +1,4 @@ -/* BKE_deform.h June 2001 - * - * support for deformation groups and hooks - * - * Reevan McKay et al - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -35,6 +30,13 @@ #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; diff --git a/source/blender/blenkernel/BKE_depsgraph.h b/source/blender/blenkernel/BKE_depsgraph.h index 91954131b71..f78a957cbab 100644 --- a/source/blender/blenkernel/BKE_depsgraph.h +++ b/source/blender/blenkernel/BKE_depsgraph.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,6 +28,10 @@ #ifndef DEPSGRAPH_API #define DEPSGRAPH_API +/** \file BKE_depsgraph.h + * \ingroup bke + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/blenkernel/BKE_displist.h b/source/blender/blenkernel/BKE_displist.h index 01d3de1b94f..766981a6fea 100644 --- a/source/blender/blenkernel/BKE_displist.h +++ b/source/blender/blenkernel/BKE_displist.h @@ -1,4 +1,3 @@ -/* display list (or rather multi purpose list) stuff */ /* $Id$ * @@ -32,6 +31,10 @@ #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" diff --git a/source/blender/blenkernel/BKE_effect.h b/source/blender/blenkernel/BKE_effect.h index 99f55200eac..97ac711651b 100644 --- a/source/blender/blenkernel/BKE_effect.h +++ b/source/blender/blenkernel/BKE_effect.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_effect.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,11 @@ #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; diff --git a/source/blender/blenkernel/BKE_endian.h b/source/blender/blenkernel/BKE_endian.h index d61b81fb6ce..5647645e990 100644 --- a/source/blender/blenkernel/BKE_endian.h +++ b/source/blender/blenkernel/BKE_endian.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,11 +26,17 @@ * * ***** 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; \ diff --git a/source/blender/blenkernel/BKE_exotic.h b/source/blender/blenkernel/BKE_exotic.h index ad59cd9c0a8..870dd7cb4d5 100644 --- a/source/blender/blenkernel/BKE_exotic.h +++ b/source/blender/blenkernel/BKE_exotic.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,12 +25,16 @@ * 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; diff --git a/source/blender/blenkernel/BKE_fcurve.h b/source/blender/blenkernel/BKE_fcurve.h index 5fbb7f37d15..f81acf4b11e 100644 --- a/source/blender/blenkernel/BKE_fcurve.h +++ b/source/blender/blenkernel/BKE_fcurve.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,6 +28,12 @@ #ifndef BKE_FCURVE_H #define BKE_FCURVE_H +/** \file BKE_fcurve.h + * \ingroup bke + * \author Joshua Leung + * \since 2009 + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/blenkernel/BKE_fluidsim.h b/source/blender/blenkernel/BKE_fluidsim.h index e730f4ec34c..f6070cd81f0 100644 --- a/source/blender/blenkernel/BKE_fluidsim.h +++ b/source/blender/blenkernel/BKE_fluidsim.h @@ -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; diff --git a/source/blender/blenkernel/BKE_font.h b/source/blender/blenkernel/BKE_font.h index c47a0b21855..7f4e7c208f6 100644 --- a/source/blender/blenkernel/BKE_font.h +++ b/source/blender/blenkernel/BKE_font.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_vfont.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef BKE_VFONT_H #define BKE_VFONT_H +/** \file BKE_font.h + * \ingroup bke + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/blenkernel/BKE_global.h b/source/blender/blenkernel/BKE_global.h index d222fe8d296..d83e0e5bc4c 100644 --- a/source/blender/blenkernel/BKE_global.h +++ b/source/blender/blenkernel/BKE_global.h @@ -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 ***** @@ -35,6 +29,15 @@ #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 diff --git a/source/blender/blenkernel/BKE_gpencil.h b/source/blender/blenkernel/BKE_gpencil.h index 898538c6820..4898bb28c8d 100644 --- a/source/blender/blenkernel/BKE_gpencil.h +++ b/source/blender/blenkernel/BKE_gpencil.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,6 +28,11 @@ #ifndef BKE_GPENCIL_H #define BKE_GPENCIL_H +/** \file BKE_gpencil.h + * \ingroup bke + * \author Joshua Leung + */ + struct ListBase; struct bGPdata; struct bGPDlayer; diff --git a/source/blender/blenkernel/BKE_group.h b/source/blender/blenkernel/BKE_group.h index 767e3c97fef..e497f43e46d 100644 --- a/source/blender/blenkernel/BKE_group.h +++ b/source/blender/blenkernel/BKE_group.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_group.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,12 @@ #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; diff --git a/source/blender/blenkernel/BKE_icons.h b/source/blender/blenkernel/BKE_icons.h index 42cbd22d9f1..5404402718d 100644 --- a/source/blender/blenkernel/BKE_icons.h +++ b/source/blender/blenkernel/BKE_icons.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +31,10 @@ #ifndef BKE_ICONS_H #define BKE_ICONS_H +/** \file BKE_icons.h + * \ingroup bke + */ + /* Resizable Icons for Blender */ diff --git a/source/blender/blenkernel/BKE_idcode.h b/source/blender/blenkernel/BKE_idcode.h index b624e34e1cb..1b2b3d2ee95 100644 --- a/source/blender/blenkernel/BKE_idcode.h +++ b/source/blender/blenkernel/BKE_idcode.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +30,10 @@ #ifndef BKE_ID_INFO_H #define BKE_ID_INFO_H +/** \file BKE_idcode.h + * \ingroup bke + */ + /** * Convert an idcode into a name. * diff --git a/source/blender/blenkernel/BKE_idprop.h b/source/blender/blenkernel/BKE_idprop.h index 0ca5690e635..e71ad5c8a24 100644 --- a/source/blender/blenkernel/BKE_idprop.h +++ b/source/blender/blenkernel/BKE_idprop.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,6 +28,11 @@ #ifndef _BKE_IDPROP_H #define _BKE_IDPROP_H +/** \file BKE_idprop.h + * \ingroup bke + * \author Joseph Eagar + */ + #include "DNA_ID.h" struct IDProperty; diff --git a/source/blender/blenkernel/BKE_image.h b/source/blender/blenkernel/BKE_image.h index 283badc6faa..8f0ce8c1660 100644 --- a/source/blender/blenkernel/BKE_image.h +++ b/source/blender/blenkernel/BKE_image.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_image.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,12 @@ #ifndef BKE_IMAGE_H #define BKE_IMAGE_H +/** \file BKE_image.h + * \ingroup bke + * \since March 2001 + * \author nzc + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/blenkernel/BKE_ipo.h b/source/blender/blenkernel/BKE_ipo.h index e700f263011..ea98c226e67 100644 --- a/source/blender/blenkernel/BKE_ipo.h +++ b/source/blender/blenkernel/BKE_ipo.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_ipo.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,13 @@ #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 diff --git a/source/blender/blenkernel/BKE_key.h b/source/blender/blenkernel/BKE_key.h index d72dce3bf7c..c29320ef13c 100644 --- a/source/blender/blenkernel/BKE_key.h +++ b/source/blender/blenkernel/BKE_key.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_key.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,11 @@ #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; diff --git a/source/blender/blenkernel/BKE_lattice.h b/source/blender/blenkernel/BKE_lattice.h index 4f405e71662..2936338e760 100644 --- a/source/blender/blenkernel/BKE_lattice.h +++ b/source/blender/blenkernel/BKE_lattice.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,12 +25,17 @@ * 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; diff --git a/source/blender/blenkernel/BKE_library.h b/source/blender/blenkernel/BKE_library.h index f956749dc9d..871a78bbab3 100644 --- a/source/blender/blenkernel/BKE_library.h +++ b/source/blender/blenkernel/BKE_library.h @@ -1,8 +1,4 @@ -/** - * blenlib/BKE_library.h (mar-2001 nzc) - * - * Library - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -33,6 +29,11 @@ #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 diff --git a/source/blender/blenkernel/BKE_main.h b/source/blender/blenkernel/BKE_main.h index 74d4cf88eda..df6a304f0b3 100644 --- a/source/blender/blenkernel/BKE_main.h +++ b/source/blender/blenkernel/BKE_main.h @@ -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 ***** @@ -38,6 +29,19 @@ #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 diff --git a/source/blender/blenkernel/BKE_material.h b/source/blender/blenkernel/BKE_material.h index 16c99cd850f..523a67eff67 100644 --- a/source/blender/blenkernel/BKE_material.h +++ b/source/blender/blenkernel/BKE_material.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,12 +25,15 @@ * 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 diff --git a/source/blender/blenkernel/BKE_mball.h b/source/blender/blenkernel/BKE_mball.h index 6f36c26dd3f..c4119e99780 100644 --- a/source/blender/blenkernel/BKE_mball.h +++ b/source/blender/blenkernel/BKE_mball.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_mball.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,11 @@ #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; diff --git a/source/blender/blenkernel/BKE_mesh.h b/source/blender/blenkernel/BKE_mesh.h index 02d52e10fa5..0f5780ed5b0 100644 --- a/source/blender/blenkernel/BKE_mesh.h +++ b/source/blender/blenkernel/BKE_mesh.h @@ -1,4 +1,4 @@ -/** +/* * blenlib/BKE_mesh.h (mar-2001 nzc) * * $Id$ @@ -31,6 +31,10 @@ #ifndef BKE_MESH_H #define BKE_MESH_H +/** \file BKE_mesh.h + * \ingroup bke + */ + /***/ struct BoundBox; diff --git a/source/blender/blenkernel/BKE_modifier.h b/source/blender/blenkernel/BKE_modifier.h index 5bef7527c87..af625ae9d9c 100644 --- a/source/blender/blenkernel/BKE_modifier.h +++ b/source/blender/blenkernel/BKE_modifier.h @@ -1,5 +1,4 @@ -/** - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +29,10 @@ #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" diff --git a/source/blender/blenkernel/BKE_multires.h b/source/blender/blenkernel/BKE_multires.h index de895ebce51..ea34ff4aa07 100644 --- a/source/blender/blenkernel/BKE_multires.h +++ b/source/blender/blenkernel/BKE_multires.h @@ -30,6 +30,10 @@ #ifndef BKE_MULTIRES_H #define BKE_MULTIRES_H +/** \file BKE_multires.h + * \ingroup bke + */ + struct DerivedMesh; struct Mesh; struct MFace; diff --git a/source/blender/blenkernel/BKE_nla.h b/source/blender/blenkernel/BKE_nla.h index 30bce613dbe..0206756a1ad 100644 --- a/source/blender/blenkernel/BKE_nla.h +++ b/source/blender/blenkernel/BKE_nla.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +30,11 @@ #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; diff --git a/source/blender/blenkernel/BKE_node.h b/source/blender/blenkernel/BKE_node.h index 57d18f58e2d..0896dfbabb1 100644 --- a/source/blender/blenkernel/BKE_node.h +++ b/source/blender/blenkernel/BKE_node.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -33,6 +33,10 @@ #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 diff --git a/source/blender/blenkernel/BKE_object.h b/source/blender/blenkernel/BKE_object.h index 100b5111717..3d32ba5a30a 100644 --- a/source/blender/blenkernel/BKE_object.h +++ b/source/blender/blenkernel/BKE_object.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,12 +25,15 @@ * 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 diff --git a/source/blender/blenkernel/BKE_packedFile.h b/source/blender/blenkernel/BKE_packedFile.h index c3ab392fd85..541c581e762 100644 --- a/source/blender/blenkernel/BKE_packedFile.h +++ b/source/blender/blenkernel/BKE_packedFile.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_packedFile.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,11 @@ #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 diff --git a/source/blender/blenkernel/BKE_paint.h b/source/blender/blenkernel/BKE_paint.h index 2203277b301..238c812906d 100644 --- a/source/blender/blenkernel/BKE_paint.h +++ b/source/blender/blenkernel/BKE_paint.h @@ -28,6 +28,10 @@ #ifndef BKE_PAINT_H #define BKE_PAINT_H +/** \file BKE_paint.h + * \ingroup bke + */ + #include "DNA_vec_types.h" struct Brush; diff --git a/source/blender/blenkernel/BKE_particle.h b/source/blender/blenkernel/BKE_particle.h index bb325420bbe..507adcc5f2d 100644 --- a/source/blender/blenkernel/BKE_particle.h +++ b/source/blender/blenkernel/BKE_particle.h @@ -1,6 +1,4 @@ -/* BKE_particle.h - * - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -32,6 +30,10 @@ #ifndef BKE_PARTICLE_H #define BKE_PARTICLE_H +/** \file BKE_particle.h + * \ingroup bke + */ + #include "DNA_particle_types.h" #include "DNA_object_types.h" diff --git a/source/blender/blenkernel/BKE_plugin_types.h b/source/blender/blenkernel/BKE_plugin_types.h index 0bb1400858d..a7842b526ce 100644 --- a/source/blender/blenkernel/BKE_plugin_types.h +++ b/source/blender/blenkernel/BKE_plugin_types.h @@ -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 ***** @@ -34,6 +29,11 @@ #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); diff --git a/source/blender/blenkernel/BKE_pointcache.h b/source/blender/blenkernel/BKE_pointcache.h index e4623a31807..346368a5958 100644 --- a/source/blender/blenkernel/BKE_pointcache.h +++ b/source/blender/blenkernel/BKE_pointcache.h @@ -29,6 +29,10 @@ #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" diff --git a/source/blender/blenkernel/BKE_property.h b/source/blender/blenkernel/BKE_property.h index 5fab97b35e5..10014a4611d 100644 --- a/source/blender/blenkernel/BKE_property.h +++ b/source/blender/blenkernel/BKE_property.h @@ -1,6 +1,4 @@ -/** - * blenkernel/BKE_property.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef BKE_PROPERTY_H #define BKE_PROPERTY_H +/** \file BKE_property.h + * \ingroup bke + */ + struct bProperty; struct ListBase; struct Object; diff --git a/source/blender/blenkernel/BKE_report.h b/source/blender/blenkernel/BKE_report.h index b84808a7ddd..397c96422a5 100644 --- a/source/blender/blenkernel/BKE_report.h +++ b/source/blender/blenkernel/BKE_report.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,6 +28,10 @@ #ifndef BKE_REPORT_H #define BKE_REPORT_H +/** \file BKE_report.h + * \ingroup bke + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/blenkernel/BKE_sca.h b/source/blender/blenkernel/BKE_sca.h index a9238dadb27..0db0b71c102 100644 --- a/source/blender/blenkernel/BKE_sca.h +++ b/source/blender/blenkernel/BKE_sca.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +29,10 @@ #ifndef BKE_SCA_H #define BKE_SCA_H +/** \file BKE_sca.h + * \ingroup bke + */ + struct Text; struct bSensor; struct Object; diff --git a/source/blender/blenkernel/BKE_scene.h b/source/blender/blenkernel/BKE_scene.h index 2337b95dcbc..ac85f91bf46 100644 --- a/source/blender/blenkernel/BKE_scene.h +++ b/source/blender/blenkernel/BKE_scene.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_scene.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,12 @@ #ifndef BKE_SCENE_H #define BKE_SCENE_H +/** \file BKE_scene.h + * \ingroup bke + * \since March 2001 + * \author nzc + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/blenkernel/BKE_screen.h b/source/blender/blenkernel/BKE_screen.h index 125486625bb..0a7d9780a6b 100644 --- a/source/blender/blenkernel/BKE_screen.h +++ b/source/blender/blenkernel/BKE_screen.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_screen.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,12 @@ #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; diff --git a/source/blender/blenkernel/BKE_script.h b/source/blender/blenkernel/BKE_script.h index 4ea1ee6db85..304e46fe2c5 100644 --- a/source/blender/blenkernel/BKE_script.h +++ b/source/blender/blenkernel/BKE_script.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_script.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,13 @@ #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 diff --git a/source/blender/blenkernel/BKE_sequencer.h b/source/blender/blenkernel/BKE_sequencer.h index 6f5fbf727c9..cc1d8537cbd 100644 --- a/source/blender/blenkernel/BKE_sequencer.h +++ b/source/blender/blenkernel/BKE_sequencer.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +31,10 @@ #ifndef BKE_SEQUENCER_H #define BKE_SEQUENCER_H +/** \file BKE_sequencer.h + * \ingroup bke + */ + struct bContext; struct Editing; struct ImBuf; diff --git a/source/blender/blenkernel/BKE_shrinkwrap.h b/source/blender/blenkernel/BKE_shrinkwrap.h index 6b8e7860db8..937a46d68dd 100644 --- a/source/blender/blenkernel/BKE_shrinkwrap.h +++ b/source/blender/blenkernel/BKE_shrinkwrap.h @@ -1,6 +1,4 @@ -/** - * BKE_shrinkwrap.h - * +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -29,6 +27,10 @@ #ifndef BKE_SHRINKWRAP_H #define BKE_SHRINKWRAP_H +/** \file BKE_shrinkwrap.h + * \ingroup bke + */ + /* mesh util */ //TODO: move this somewhere else diff --git a/source/blender/blenkernel/BKE_sketch.h b/source/blender/blenkernel/BKE_sketch.h index a59464bb7ba..f42d733d583 100644 --- a/source/blender/blenkernel/BKE_sketch.h +++ b/source/blender/blenkernel/BKE_sketch.h @@ -1,5 +1,4 @@ -/** - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,6 +24,10 @@ #ifndef BKE_SKETCH_H #define BKE_SKETCH_H +/** \file BKE_sketch.h + * \ingroup bke + */ + typedef enum SK_PType { PT_CONTINUOUS, diff --git a/source/blender/blenkernel/BKE_smoke.h b/source/blender/blenkernel/BKE_smoke.h index 396db60714a..16e5336bcc1 100644 --- a/source/blender/blenkernel/BKE_smoke.h +++ b/source/blender/blenkernel/BKE_smoke.h @@ -1,6 +1,4 @@ -/** - * BKE_smoke.h - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -32,6 +30,11 @@ #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); diff --git a/source/blender/blenkernel/BKE_softbody.h b/source/blender/blenkernel/BKE_softbody.h index 738fe7dde82..6aea9344070 100644 --- a/source/blender/blenkernel/BKE_softbody.h +++ b/source/blender/blenkernel/BKE_softbody.h @@ -1,6 +1,4 @@ -/** - * BKE_softbody.h - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef BKE_SOFTBODY_H #define BKE_SOFTBODY_H +/** \file BKE_softbody.h + * \ingroup bke + */ + struct Object; struct Scene; struct SoftBody; diff --git a/source/blender/blenkernel/BKE_sound.h b/source/blender/blenkernel/BKE_sound.h index cf77049b599..c5fcea63a47 100644 --- a/source/blender/blenkernel/BKE_sound.h +++ b/source/blender/blenkernel/BKE_sound.h @@ -1,6 +1,4 @@ -/** - * sound.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,12 @@ #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; diff --git a/source/blender/blenkernel/BKE_subsurf.h b/source/blender/blenkernel/BKE_subsurf.h index ef3ad3ad2e9..b82db853d37 100644 --- a/source/blender/blenkernel/BKE_subsurf.h +++ b/source/blender/blenkernel/BKE_subsurf.h @@ -28,6 +28,10 @@ #ifndef BKE_SUBSURF_H #define BKE_SUBSURF_H +/** \file BKE_subsurf.h + * \ingroup bke + */ + struct DMGridAdjacency; struct DMGridData; struct DerivedMesh; diff --git a/source/blender/blenkernel/BKE_suggestions.h b/source/blender/blenkernel/BKE_suggestions.h index 9eb8897e0e0..e215cabd70f 100644 --- a/source/blender/blenkernel/BKE_suggestions.h +++ b/source/blender/blenkernel/BKE_suggestions.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +29,10 @@ #ifndef BKE_SUGGESTIONS_H #define BKE_SUGGESTIONS_H +/** \file BKE_suggestions.h + * \ingroup bke + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/blenkernel/BKE_text.h b/source/blender/blenkernel/BKE_text.h index 5f55f8b351e..a6b98b8ea88 100644 --- a/source/blender/blenkernel/BKE_text.h +++ b/source/blender/blenkernel/BKE_text.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_text.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,12 @@ #ifndef BKE_TEXT_H #define BKE_TEXT_H +/** \file BKE_text.h + * \ingroup bke + * \since March 2001 + * \author nzc + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/blenkernel/BKE_texture.h b/source/blender/blenkernel/BKE_texture.h index da9f13e07bc..e6a21ec3966 100644 --- a/source/blender/blenkernel/BKE_texture.h +++ b/source/blender/blenkernel/BKE_texture.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_texture.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,12 @@ #ifndef BKE_TEXTURE_H #define BKE_TEXTURE_H +/** \file BKE_texture.h + * \ingroup bke + * \since March 2001 + * \author nzc + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/blenkernel/BKE_unit.h b/source/blender/blenkernel/BKE_unit.h index 5708766432f..0a3e56c8cba 100644 --- a/source/blender/blenkernel/BKE_unit.h +++ b/source/blender/blenkernel/BKE_unit.h @@ -1,4 +1,4 @@ -/** +/* * * ***** BEGIN GPL LICENSE BLOCK ***** * @@ -24,6 +24,10 @@ #ifndef BKE_UNIT_H #define BKE_UNIT_H +/** \file BKE_unit.h + * \ingroup bke + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/blenkernel/BKE_utildefines.h b/source/blender/blenkernel/BKE_utildefines.h index fca6a8cbef8..14e622c972e 100644 --- a/source/blender/blenkernel/BKE_utildefines.h +++ b/source/blender/blenkernel/BKE_utildefines.h @@ -27,8 +27,12 @@ * ***** 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 diff --git a/source/blender/blenkernel/BKE_world.h b/source/blender/blenkernel/BKE_world.h index 8c6da40fcea..30780b87085 100644 --- a/source/blender/blenkernel/BKE_world.h +++ b/source/blender/blenkernel/BKE_world.h @@ -1,6 +1,4 @@ -/** - * blenlib/BKE_world.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,12 @@ #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); diff --git a/source/blender/blenkernel/BKE_writeavi.h b/source/blender/blenkernel/BKE_writeavi.h index c7f26d9b76c..19cc1ae2dbf 100644 --- a/source/blender/blenkernel/BKE_writeavi.h +++ b/source/blender/blenkernel/BKE_writeavi.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +30,10 @@ #ifndef BKE_WRITEAVI_H #define BKE_WRITEAVI_H +/** \file BKE_writeavi.h + * \ingroup bke + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/blenkernel/BKE_writeffmpeg.h b/source/blender/blenkernel/BKE_writeffmpeg.h index 311676b37b5..2b10f1b246c 100644 --- a/source/blender/blenkernel/BKE_writeffmpeg.h +++ b/source/blender/blenkernel/BKE_writeffmpeg.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -28,6 +28,10 @@ #ifndef BKE_WRITEFFMPEG_H #define BKE_WRITEFFMPEG_H +/** \file BKE_writeffmpeg.h + * \ingroup bke + */ + #ifdef WITH_FFMPEG #ifdef __cplusplus diff --git a/source/blender/blenkernel/BKE_writeframeserver.h b/source/blender/blenkernel/BKE_writeframeserver.h index 036e0dbd774..2117a23b938 100644 --- a/source/blender/blenkernel/BKE_writeframeserver.h +++ b/source/blender/blenkernel/BKE_writeframeserver.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -28,6 +28,10 @@ #ifndef BKE_WRITEFRAMESERVER_H #define BKE_WRITEFRAMESERVER_H +/** \file BKE_writeframeserver.h + * \ingroup bke + */ + #ifdef __cplusplus extern "C" { #endif |