diff --git a/doc/Doxyfile b/doc/Doxyfile index 58622b34ff8d3250dd0691e9e0ea591a2e047866..0776736a5e02958a675d21e4e2558036e0e8b7e3 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -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 diff --git a/doc/doxygen.main b/doc/doxygen.main index c7db6539cbe9908f2bcc7199d167d284df6dc80b..201596c0e7ab0b2c20df84eb3857852daeccfbc1 100644 --- a/doc/doxygen.main +++ b/doc/doxygen.main @@ -72,6 +72,16 @@ * \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 */ diff --git a/source/blender/blenkernel/BKE_DerivedMesh.h b/source/blender/blenkernel/BKE_DerivedMesh.h index 1f56c164fccd4ff0af69c2a716e146ae7590d08c..857c88a6004351e49015a07b2d6f97f11474d619 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 1c75387ba5dea58bbce448fda45acb731bf2cb64..59da97d8b09fd90adc61b51747fc189f8201bfc1 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 e82eb0ed0c96f3f98926313782fc0df5603a0a35..25165eeaee73de28ac3500fe659e4770f448bc76 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 500210d2fcd593f786853d06c4bf05d3cdd914ad..a469d05ee265bd932f9cc9a06595d5f20f6275f5 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 5fb5dc4969d3a0819e70dfb08d30867f31045d23..efa87532859d2513697e708baf7edc37e61501e9 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 8fe32da437cdc2e3616095a37737835c3f6b6fb8..42c4c2ebdd08018f6433e705f051549670449355 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 65e7f848ea00e6b4800e907339f5ed3d21122daf..aa04e20beb62dde7ba57c06ff0c10c62f434e70e 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 44ca3842fd98387e46c02a66095555139ce5a201..5c28fa8850380c3a61a193632a0056440049db3f 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 d2b72019b6896ca7a06d2e5bd9766d65df6e1a9c..aabfcfaa0f6305dc9d9ebc3ab00f38e23271ec19 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 6a47dcbd6c43185c9de349ffc893d68ab8d804e3..ef7323fc4c366270bdda8b9471c39bfddb267709 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 77a618c1be407494f629e3a180e0f2885974e43b..658302e9f1d0d1df42f8cddb057fe4bf27f2efec 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 ffd803f21a5358ac48b96a9cc8db98fb1343b4e4..36ca0cde87df6ba44981a261155064ee37cb9673 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 7c2d619659aaa8b5bc82a34e096422dc88695db7..aecd3385662bc655979efbc845c68015d3690af7 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 de6da9883e1d1757ab23a2630cabf4182635afcd..a9d379e6c694ec8d559f0ca6a634e7944987b85b 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 b695bdc91aeeb05fdfef9132184efce4dc45f8db..76358c4485be7b21efb813403be338a417626fed 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 975e64929c2603ea8f1a322149ece7c8cd44213f..29487713ad4c4291e1a1c81df1147a20ab4e7fbd 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 bff9f16b4895ad9eff51a42e84ff4da9ebb4ac64..1edec2b69d9bd706e09754c5ef43e847b4674f52 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 83af573bd42739d26d0db567d6fd411cf029ae4d..1ee51cd2122db196a2dc1559a3da1921a6ee341f 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 03d4800076cbf2c86fff76f3a2b87cac05988cac..b54d4275719729ba2480ab0ad6487c274d3dfd68 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 e0ebedb320b208b482a4ff40d1cefec867470044..b3709853a8c83f74331d35a50d6c6c83010a5469 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 d6e0075df1e26d978cc59e48334754fd4ffda941..7c0e7050a9f8a9d089674b3e7a579f73e1158adc 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 3acc08a76b6d9c211a9d98031bda4006f92f6ef1..7254536b5557c74ca848d0f12dadcfbbdac99a54 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 8c652a11794be5e59eafa57e3d8e4343100bdefa..f0c58e0a511ad62d5a8cb9223bfc627d37f77561 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 e91183236829eff144da65999be96a0e794f05c7..c30100ea55abc5cc9a29a64f7cb5484aad41b0ac 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 9bcef7636c60e32f6e5bd1f7e9bb89299a241413..f97565f23a11a6141e8b8fd85704edbf4298fa9d 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 eaabc57c781455208e320230178919eeef1faedd..a9ac201beda64c0a5b174e21040b9699df9483af 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 91954131b711134f5e1725a26444adb8f473b33f..f78a957cbab436b33cff937cf110bd186d1af984 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 01d3de1b94fd0897b9e331612516a7baaefaa254..766981a6fea1eb8c912a9869293f51980c7846f9 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 99f55200eac4fa54912b8fd3a5d5f5f66cf5c03b..97ac711651b6b3cb0d2d66c942d0d997af38b1c7 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 d61b81fb6ce3ea97c42b2a6e11c688abc31108bb..5647645e99053c77c3f7abcc7393c3045b46b1a2 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 ad59cd9c0a8a30935332b725ce8bd71f90035be8..870dd7cb4d5b0e238eb7e3cc3d67ab7d39959b63 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 5fbb7f37d15aee80e31401b761619968f34192c4..f81acf4b11e5fd387b1b1eaae449b7392b5e705c 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 e730f4ec34c3bdeab166b8a775f56b53d3e76e65..f6070cd81f0541d0fa8888f3577221776b444f04 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 c47a0b218551b0718caf17389cec2601eb6507f8..7f4e7c208f6d6a56e5f418a04e9370d23eea42e2 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 d222fe8d296f0efdad468a5f6230db2e68ea7854..d83e0e5bc4c02bc5d40ecd96d79f0f0157968565 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 898538c6820d7a43b56d6e694ae85a09cb536784..4898bb28c8def81b49ac77bba7019ca6fb7422d8 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 767e3c97fef7f64aa4d23977bb958ab020d77872..e497f43e46d4ac261d75f9bb8e61026716bc8152 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 42cbd22d9f1be0982531661b339b8bfd7cc66b19..5404402718dc2c55fcd011228111c715b3b55f22 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 b624e34e1cb5d3e674dbe51c10edff2c73a72c9d..1b2b3d2ee95c2704319103845b42f16383b2e410 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 0ca5690e635cb21809f2ad6c308819fa57edd04e..e71ad5c8a24c714d2c28da5eacbfb8b48ebdea14 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 283badc6faa3f1030bb16a5cddb353173a1d2e42..8f0ce8c1660566e08c2a22234a99388df880ebd3 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 e700f263011f22e65516e5f7f0ce62e39741c440..ea98c226e678b6ef2c4e603bcc847bd2665f2fb3 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 d72dce3bf7ca58eb6b7689a9b4e92971ee52829a..c29320ef13c2e3505cfd5d429012af42eab95bfc 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 4f405e71662c68321ebd891e6ab49b22dfb4328a..2936338e760e2ac95db436fdf8a30fbe809d1ef2 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 f956749dc9daaaabe398869132c4f8de42441e82..871a78bbab388b68de41e5eb170415241a51c056 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 74d4cf88eda9ff070a8def6d2fad51cf89de0243..df6a304f0b3c73d8e0391f5e892d561dfce0a6a9 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 16c99cd850fdd8a2997c689ff8f30a482b2d56a5..523a67eff6758bfd0d01548505e17035efeae65f 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 6f36c26dd3fd388d8a64d79f634579ff84bd529a..c4119e9978006abe42a75dc2f38152ceb875b8cb 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 02d52e10fa5be7edea4b853f1a20645c29b68b81..0f5780ed5b01b9962b31416c0adfbad1b001aca1 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 5bef7527c87d5f4fb84f752d913376d5b94f7763..af625ae9d9c3eca0dba342569563bed582ec3fe8 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 de895ebce5184c1a1f5118cdd84bcd6b04f1f19b..ea34ff4aa0789050e4f1b15aad4752ea7fd182a6 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 30bce613dbe6ab8895daf58ed5968a78d9fd7e75..0206756a1ad0a097321dbbb76e4591674a496500 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 57d18f58e2d18589317c342aa6cf629246c62864..0896dfbabb1ef47789228f84c8af27f21cedf4ef 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 100b51117171439a5396ca5aef28e2bd014a816d..3d32ba5a30a23f2c37794e3849556ca360cbc623 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 c3ab392fd8501cc2a81981be29968810ac51e2b1..541c581e76203339f4daf369fbc2093f28719749 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 2203277b30167be7a691ec3ed2a5a166f88ec2c6..238c812906d7f3168a0e565d0ea8a745a6e74deb 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 bb325420bbea68dc46e812e07c65440131b4605d..507adcc5f2d9c477dd6e952e3969d212edb17397 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 0bb1400858d616571eef0cc4e09331df7b6ee914..a7842b526ce2ad4908e5545584e18c52ce1be444 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 e4623a31807872d49b4973124a845931dcdc6c10..346368a5958dbcba35bc55752248c60077843bbc 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 5fab97b35e52d1ce9185a945a5f691d7b571d219..10014a4611d42e3be99a295fbaba8c82c76bbbcd 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 b84808a7ddd84e24649e60e4f73e04db4b70ce1a..397c96422a5c9a0c7dbb01bda917038266afcafb 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 a9238dadb2765e913ba6dbfae7307fa6ed6c81c9..0db0b71c1028da14cfa25291d3bd16877643353c 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 2337b95dcbc6f822d0071756e41c13f42e5a9488..ac85f91bf465219baa0347ff8475a9b73c71d851 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 125486625bb8176c101f6f6e837b90d08af701cd..0a7d9780a6bd5ebcda4e31a78a13503405176cad 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 4ea1ee6db85390808dcac8bc36fbe846a27c38ca..304e46fe2c549f8ae04dad45aa9c34043e9c17a1 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 6f5fbf727c921bb51ac739e279ac946bb4c6ca8b..cc1d8537cbd4c39516b39f117ad84ff7a2fee22a 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 6b8e7860db80652128e215e0ed87bcb5bef4e074..937a46d68dd947dbf24bde4b5f9e6e59b273e2e0 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 a59464bb7bac6e6124563d8050aaea6ae0108633..f42d733d5838bcedff96d4daaea110d7d3b31295 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 396db60714a1271f7fa3a1f8e549aafcd0e057cb..16e5336bcc1a1e7b538dbcf7c8460cac7c224f93 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 738fe7dde821a10178d834efff3f503620f8d3e1..6aea93440702c02c2abe16c2bcaeabd02f18568d 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 cf77049b59965da7c2874c90d062d237c0ea40d3..c5fcea63a4770a455d602e27142632bb607f8269 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 ef3ad3ad2e90358673f549ad05d6107af3e3360d..b82db853d371d13709acfd53d14c9c61120b310f 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 9eb8897e0e0462ac86c5921e3e81e850cf0659a9..e215cabd70ff6d76ad3c9884ea9138591afed337 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 5f55f8b351e18d34b8d421b4b673451107ce39a3..a6b98b8ea882ee2d45d4b6406a754d0dae4e941d 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 da9f13e07bcd5ecbc4769b5bef6307d77d72b73f..e6a21ec3966aed63df1c80c04cef8c86e16d0df0 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 5708766432f844fd2c5b0795d5fcca6319d47eb1..0a3e56c8cba2303bd0e048b3f13ec8f6779349d8 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 fca6a8cbef8718e82ec48228fc41f255073e7fd7..14e622c972ebf0df3996080155472be84bc1ce05 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 8c6da40fcea4078b59248e12e8baeb64a3d23be4..30780b87085da05f49af77973dc05be4edaad999 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 c7f26d9b76cfeb4f3cf18f5a40ac72b3154faf9a..19cc1ae2dbf3546fe65b3f630d6023e2259cc3a3 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 311676b37b5e4c7172556f7fc993ad0c96c86844..2b10f1b246ce7d9c2c98a41ef00e4c1a8a9a4c71 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 036e0dbd77490ebf2cc65a898bad4d40a409d575..2117a23b938d079e4d992dccbe7f513dc5db9dad 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