From 22dbae84e5ed0fa836f5f84faaeb51a7ec585c64 Mon Sep 17 00:00:00 2001 From: Nathan Letwory Date: Thu, 17 Feb 2011 20:48:12 +0000 Subject: DNA header files are now grouped under the same module. No further documentation done. --- source/blender/makesdna/DNA_ID.h | 11 ++++++----- source/blender/makesdna/DNA_anim_types.h | 6 +++++- source/blender/makesdna/DNA_armature_types.h | 6 +++++- source/blender/makesdna/DNA_boid_types.h | 8 +++++--- source/blender/makesdna/DNA_brush_types.h | 7 ++++++- source/blender/makesdna/DNA_camera_types.h | 8 +++++--- source/blender/makesdna/DNA_cloth_types.h | 6 +++++- source/blender/makesdna/DNA_color_types.h | 7 +++++-- source/blender/makesdna/DNA_constraint_types.h | 6 +++++- source/blender/makesdna/DNA_controller_types.h | 8 +++++--- source/blender/makesdna/DNA_curve_types.h | 10 +++++----- source/blender/makesdna/DNA_customdata_types.h | 2 +- source/blender/makesdna/DNA_effect_types.h | 8 +++++--- source/blender/makesdna/DNA_fileglobal_types.h | 8 +++++--- source/blender/makesdna/DNA_genfile.h | 6 +++++- source/blender/makesdna/DNA_gpencil_types.h | 6 +++++- source/blender/makesdna/DNA_group_types.h | 6 +++++- source/blender/makesdna/DNA_image_types.h | 8 +++++--- source/blender/makesdna/DNA_ipo_types.h | 20 ++++++++------------ source/blender/makesdna/DNA_key_types.h | 8 +++++--- source/blender/makesdna/DNA_lamp_types.h | 8 +++++--- source/blender/makesdna/DNA_lattice_types.h | 6 +++++- source/blender/makesdna/DNA_listBase.h | 12 +++++++----- source/blender/makesdna/DNA_material_types.h | 8 +++++--- source/blender/makesdna/DNA_mesh_types.h | 6 +++++- source/blender/makesdna/DNA_meshdata_types.h | 6 +++++- source/blender/makesdna/DNA_meta_types.h | 8 +++++--- source/blender/makesdna/DNA_modifier_types.h | 12 ++++++++---- source/blender/makesdna/DNA_nla_types.h | 6 +++++- source/blender/makesdna/DNA_node_types.h | 6 +++++- source/blender/makesdna/DNA_object_fluidsim.h | 6 +++++- source/blender/makesdna/DNA_object_force.h | 6 +++++- source/blender/makesdna/DNA_object_types.h | 11 ++++++----- source/blender/makesdna/DNA_outliner_types.h | 6 +++++- source/blender/makesdna/DNA_packedFile_types.h | 11 +++++++---- source/blender/makesdna/DNA_particle_types.h | 8 +++++--- source/blender/makesdna/DNA_property_types.h | 11 ++++++++--- source/blender/makesdna/DNA_scene_types.h | 6 +++++- source/blender/makesdna/DNA_screen_types.h | 6 +++++- source/blender/makesdna/DNA_sensor_types.h | 10 +++++++--- source/blender/makesdna/DNA_sequence_types.h | 9 ++++++--- source/blender/makesdna/DNA_smoke_types.h | 6 +++++- source/blender/makesdna/DNA_sound_types.h | 9 ++++++--- source/blender/makesdna/DNA_space_types.h | 9 ++++++--- source/blender/makesdna/DNA_text_types.h | 9 ++++++--- source/blender/makesdna/DNA_texture_types.h | 10 +++++++--- source/blender/makesdna/DNA_userdef_types.h | 10 +++++++--- source/blender/makesdna/DNA_vec_types.h | 14 +++++++++++--- source/blender/makesdna/DNA_vfont_types.h | 10 +++++++--- source/blender/makesdna/DNA_view2d_types.h | 8 +++++--- source/blender/makesdna/DNA_view3d_types.h | 8 +++++--- source/blender/makesdna/DNA_windowmanager_types.h | 6 +++++- source/blender/makesdna/DNA_world_types.h | 8 +++++--- 53 files changed, 295 insertions(+), 135 deletions(-) (limited to 'source/blender') diff --git a/source/blender/makesdna/DNA_ID.h b/source/blender/makesdna/DNA_ID.h index 7d4d3d7c333..267283ee47a 100644 --- a/source/blender/makesdna/DNA_ID.h +++ b/source/blender/makesdna/DNA_ID.h @@ -1,8 +1,4 @@ -/** - * blenlib/DNA_ID.h (mar-2001 nzc) - * - * ID and Library types, which are fundamental for sdna, - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -33,6 +29,11 @@ #ifndef DNA_ID_H #define DNA_ID_H +/** \file DNA_ID.h + * \ingroup DNA + * \brief ID and Library types, which are fundamental for sdna. + */ + #include "DNA_listBase.h" #ifdef __cplusplus diff --git a/source/blender/makesdna/DNA_anim_types.h b/source/blender/makesdna/DNA_anim_types.h index e09d7635f75..31e02ff1877 100644 --- a/source/blender/makesdna/DNA_anim_types.h +++ b/source/blender/makesdna/DNA_anim_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,6 +28,10 @@ #ifndef DNA_ANIM_TYPES_H #define DNA_ANIM_TYPES_H +/** \file DNA_anim_types.h + * \ingroup DNA + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/makesdna/DNA_armature_types.h b/source/blender/makesdna/DNA_armature_types.h index 68375615614..3547101612f 100644 --- a/source/blender/makesdna/DNA_armature_types.h +++ b/source/blender/makesdna/DNA_armature_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,6 +28,10 @@ #ifndef DNA_ARMATURE_TYPES_H #define DNA_ARMATURE_TYPES_H +/** \file DNA_armature_types.h + * \ingroup DNA + */ + #include "DNA_listBase.h" #include "DNA_ID.h" diff --git a/source/blender/makesdna/DNA_boid_types.h b/source/blender/makesdna/DNA_boid_types.h index 83f8f4d0199..8ce6b0cc2bb 100644 --- a/source/blender/makesdna/DNA_boid_types.h +++ b/source/blender/makesdna/DNA_boid_types.h @@ -1,6 +1,4 @@ -/* DNA_particle_types.h - * - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -32,6 +30,10 @@ #ifndef DNA_BOID_TYPES_H #define DNA_BOID_TYPES_H +/** \file DNA_boid_types.h + * \ingroup DNA + */ + #include "DNA_listBase.h" typedef enum BoidRuleType { diff --git a/source/blender/makesdna/DNA_brush_types.h b/source/blender/makesdna/DNA_brush_types.h index 6ddad214af4..3693f43b69e 100644 --- a/source/blender/makesdna/DNA_brush_types.h +++ b/source/blender/makesdna/DNA_brush_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +30,11 @@ #ifndef DNA_BRUSH_TYPES_H #define DNA_BRUSH_TYPES_H +/** \file DNA_brush_types.h + * \ingroup DNA + */ + + #include "DNA_ID.h" #include "DNA_texture_types.h" /* for MTex */ diff --git a/source/blender/makesdna/DNA_camera_types.h b/source/blender/makesdna/DNA_camera_types.h index 11c8533783e..4ebd7318ea8 100644 --- a/source/blender/makesdna/DNA_camera_types.h +++ b/source/blender/makesdna/DNA_camera_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_camera_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef DNA_CAMERA_TYPES_H #define DNA_CAMERA_TYPES_H +/** \file DNA_camera_types.h + * \ingroup DNA + */ + #include "DNA_ID.h" #ifdef __cplusplus diff --git a/source/blender/makesdna/DNA_cloth_types.h b/source/blender/makesdna/DNA_cloth_types.h index 9b9f0ede526..1f78366287f 100644 --- a/source/blender/makesdna/DNA_cloth_types.h +++ b/source/blender/makesdna/DNA_cloth_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +29,10 @@ #ifndef DNA_CLOTH_TYPES_H #define DNA_CLOTH_TYPES_H +/** \file DNA_cloth_types.h + * \ingroup DNA + */ + /** * This struct contains all the global data required to run a simulation. * At the time of this writing, this structure contains data appropriate diff --git a/source/blender/makesdna/DNA_color_types.h b/source/blender/makesdna/DNA_color_types.h index 83cd7979ce7..3b5a1865832 100644 --- a/source/blender/makesdna/DNA_color_types.h +++ b/source/blender/makesdna/DNA_color_types.h @@ -1,5 +1,4 @@ -/** - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +29,10 @@ #ifndef DNA_COLOR_TYPES_H #define DNA_COLOR_TYPES_H +/** \file DNA_color_types.h + * \ingroup DNA + */ + #include "DNA_vec_types.h" /* general defines for kernel functions */ diff --git a/source/blender/makesdna/DNA_constraint_types.h b/source/blender/makesdna/DNA_constraint_types.h index 275ffd93ae5..1d752fce4ef 100644 --- a/source/blender/makesdna/DNA_constraint_types.h +++ b/source/blender/makesdna/DNA_constraint_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +31,10 @@ #ifndef DNA_CONSTRAINT_TYPES_H #define DNA_CONSTRAINT_TYPES_H +/** \file DNA_constraint_types.h + * \ingroup DNA + */ + #include "DNA_ID.h" #include "DNA_listBase.h" diff --git a/source/blender/makesdna/DNA_controller_types.h b/source/blender/makesdna/DNA_controller_types.h index fcd5587b14b..e48386e5c4e 100644 --- a/source/blender/makesdna/DNA_controller_types.h +++ b/source/blender/makesdna/DNA_controller_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_controller_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef DNA_CONTROLLER_TYPES_H #define DNA_CONTROLLER_TYPES_H +/** \file DNA_controller_types.h + * \ingroup DNA + */ + struct bActuator; struct Text; struct bSensor; diff --git a/source/blender/makesdna/DNA_curve_types.h b/source/blender/makesdna/DNA_curve_types.h index d66246a4136..b51612037fc 100644 --- a/source/blender/makesdna/DNA_curve_types.h +++ b/source/blender/makesdna/DNA_curve_types.h @@ -1,8 +1,4 @@ -/** - * blenlib/DNA_curve_types.h (mar-2001 nzc) - * - * Curve stuff. - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -33,6 +29,10 @@ #ifndef DNA_CURVE_TYPES_H #define DNA_CURVE_TYPES_H +/** \file DNA_curve_types.h + * \ingroup DNA + */ + #include "DNA_listBase.h" #include "DNA_vec_types.h" #include "DNA_ID.h" diff --git a/source/blender/makesdna/DNA_customdata_types.h b/source/blender/makesdna/DNA_customdata_types.h index 4f8dd0317cb..cdfcf465c6c 100644 --- a/source/blender/makesdna/DNA_customdata_types.h +++ b/source/blender/makesdna/DNA_customdata_types.h @@ -27,7 +27,7 @@ * ***** END GPL LICENSE BLOCK ***** */ -/** @file DNA_customdata_types.h +/** \file DNA_customdata_types.h * \ingroup DNA */ diff --git a/source/blender/makesdna/DNA_effect_types.h b/source/blender/makesdna/DNA_effect_types.h index ee0b791a274..f87698a3d64 100644 --- a/source/blender/makesdna/DNA_effect_types.h +++ b/source/blender/makesdna/DNA_effect_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_effect_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef DNA_EFFECT_TYPES_H #define DNA_EFFECT_TYPES_H +/** \file DNA_effect_types.h + * \ingroup DNA + */ + /* don't forget, new effects also in writefile.c for dna!!! */ #define PAF_MAXMULT 4 diff --git a/source/blender/makesdna/DNA_fileglobal_types.h b/source/blender/makesdna/DNA_fileglobal_types.h index 0c3a9429de6..9aa3e1eb3c1 100644 --- a/source/blender/makesdna/DNA_fileglobal_types.h +++ b/source/blender/makesdna/DNA_fileglobal_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_fileglobal_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef DNA_FILEGLOBAL_TYPES_H #define DNA_FILEGLOBAL_TYPES_H +/** \file DNA_fileglobal_types.h + * \ingroup DNA + */ + struct bScreen; struct Scene; diff --git a/source/blender/makesdna/DNA_genfile.h b/source/blender/makesdna/DNA_genfile.h index 8e00a89af09..e8ed6580206 100644 --- a/source/blender/makesdna/DNA_genfile.h +++ b/source/blender/makesdna/DNA_genfile.h @@ -25,12 +25,16 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * blenloader genfile private function prototypes */ #ifndef GENFILE_H #define GENFILE_H +/** \file DNA_genfile.h + * \ingroup DNA + * \brief blenloader genfile private function prototypes + */ + struct SDNA; extern unsigned char DNAstr[]; /* DNA.c */ diff --git a/source/blender/makesdna/DNA_gpencil_types.h b/source/blender/makesdna/DNA_gpencil_types.h index 25378173929..ffccc08048e 100644 --- a/source/blender/makesdna/DNA_gpencil_types.h +++ b/source/blender/makesdna/DNA_gpencil_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ #ifndef DNA_GPENCIL_TYPES_H #define DNA_GPENCIL_TYPES_H +/** \file DNA_gpencil_types.h + * \ingroup DNA + */ + #include "DNA_listBase.h" #include "DNA_ID.h" diff --git a/source/blender/makesdna/DNA_group_types.h b/source/blender/makesdna/DNA_group_types.h index 7416f6ea397..106b85a5372 100644 --- a/source/blender/makesdna/DNA_group_types.h +++ b/source/blender/makesdna/DNA_group_types.h @@ -1,4 +1,4 @@ -/** +/* * blenlib/DNA_group_types.h (mar-2001 nzc) * * $Id$ @@ -31,6 +31,10 @@ #ifndef DNA_GROUP_TYPES_H #define DNA_GROUP_TYPES_H +/** \file DNA_group_types.h + * \ingroup DNA + */ + #include "DNA_listBase.h" #include "DNA_ID.h" diff --git a/source/blender/makesdna/DNA_image_types.h b/source/blender/makesdna/DNA_image_types.h index 3df3c8b41c6..99ed2319415 100644 --- a/source/blender/makesdna/DNA_image_types.h +++ b/source/blender/makesdna/DNA_image_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_image_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef DNA_IMAGE_TYPES_H #define DNA_IMAGE_TYPES_H +/** \file DNA_image_types.h + * \ingroup DNA + */ + #include "DNA_ID.h" struct PackedFile; diff --git a/source/blender/makesdna/DNA_ipo_types.h b/source/blender/makesdna/DNA_ipo_types.h index d0554a7aaa5..5dba9154a3a 100644 --- a/source/blender/makesdna/DNA_ipo_types.h +++ b/source/blender/makesdna/DNA_ipo_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_ipo_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,15 +27,13 @@ * ***** END GPL LICENSE BLOCK ***** */ -/* ============================================== - * ATTENTION: - * - * The contents of this file are now officially depreceated. They were used for the 'old' animation system, - * which has (as of 2.50) been replaced with a completely new system by Joshua Leung (aligorith). All defines, - * etc. are only still maintained to provide backwards compatability for old files... - * - * ============================================= - */ +/** \file DNA_ipo_types.h + * \ingroup DNA + * \deprecated + * The contents of this file are now officially depreceated. They were used for the 'old' animation system, + * which has (as of 2.50) been replaced with a completely new system by Joshua Leung (aligorith). All defines, + * etc. are only still maintained to provide backwards compatability for old files. + */ #ifndef DNA_IPO_TYPES_H #define DNA_IPO_TYPES_H diff --git a/source/blender/makesdna/DNA_key_types.h b/source/blender/makesdna/DNA_key_types.h index 3cdb5c7ebd9..2d5960aa309 100644 --- a/source/blender/makesdna/DNA_key_types.h +++ b/source/blender/makesdna/DNA_key_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_key_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef DNA_KEY_TYPES_H #define DNA_KEY_TYPES_H +/** \file DNA_key_types.h + * \ingroup DNA + */ + #include "DNA_listBase.h" #include "DNA_ID.h" diff --git a/source/blender/makesdna/DNA_lamp_types.h b/source/blender/makesdna/DNA_lamp_types.h index 1028d733c65..9377b5d8a09 100644 --- a/source/blender/makesdna/DNA_lamp_types.h +++ b/source/blender/makesdna/DNA_lamp_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_lamp_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef DNA_LAMP_TYPES_H #define DNA_LAMP_TYPES_H +/** \file DNA_lamp_types.h + * \ingroup DNA + */ + #include "DNA_ID.h" #ifndef MAX_MTEX diff --git a/source/blender/makesdna/DNA_lattice_types.h b/source/blender/makesdna/DNA_lattice_types.h index bf2ada51155..662ef9e8a45 100644 --- a/source/blender/makesdna/DNA_lattice_types.h +++ b/source/blender/makesdna/DNA_lattice_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +29,10 @@ #ifndef DNA_LATTICE_TYPES_H #define DNA_LATTICE_TYPES_H +/** \file DNA_lattice_types.h + * \ingroup DNA + */ + #include "DNA_ID.h" struct AnimData; diff --git a/source/blender/makesdna/DNA_listBase.h b/source/blender/makesdna/DNA_listBase.h index afeb79037f5..f52325c0e7b 100644 --- a/source/blender/makesdna/DNA_listBase.h +++ b/source/blender/makesdna/DNA_listBase.h @@ -1,6 +1,4 @@ -/** - * blenlib/BLI_listBase.h mar 2001 Nzc - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,14 +26,18 @@ * * ***** END GPL LICENSE BLOCK ***** * - * These structs are the foundation for all linked lists in the - * library system. * */ #ifndef DNA_LISTBASE_H #define DNA_LISTBASE_H +/** \file DNA_listBase.h + * \ingroup DNA + * \brief These structs are the foundation for all linked lists in the + * library system. + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/makesdna/DNA_material_types.h b/source/blender/makesdna/DNA_material_types.h index 5a117d59f8a..860da1d80a4 100644 --- a/source/blender/makesdna/DNA_material_types.h +++ b/source/blender/makesdna/DNA_material_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_material_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef DNA_MATERIAL_TYPES_H #define DNA_MATERIAL_TYPES_H +/** \file DNA_material_types.h + * \ingroup DNA + */ + #include "DNA_ID.h" #include "DNA_listBase.h" diff --git a/source/blender/makesdna/DNA_mesh_types.h b/source/blender/makesdna/DNA_mesh_types.h index 853c123e5d7..bd2a6a996b5 100644 --- a/source/blender/makesdna/DNA_mesh_types.h +++ b/source/blender/makesdna/DNA_mesh_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +29,10 @@ #ifndef DNA_MESH_TYPES_H #define DNA_MESH_TYPES_H +/** \file DNA_mesh_types.h + * \ingroup DNA + */ + #include "DNA_listBase.h" #include "DNA_ID.h" #include "DNA_customdata_types.h" diff --git a/source/blender/makesdna/DNA_meshdata_types.h b/source/blender/makesdna/DNA_meshdata_types.h index 9761eda5de7..e3510b3a25a 100644 --- a/source/blender/makesdna/DNA_meshdata_types.h +++ b/source/blender/makesdna/DNA_meshdata_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +29,10 @@ #ifndef DNA_MESHDATA_TYPES_H #define DNA_MESHDATA_TYPES_H +/** \file DNA_meshdata_types.h + * \ingroup DNA + */ + #include "DNA_customdata_types.h" #include "DNA_listBase.h" diff --git a/source/blender/makesdna/DNA_meta_types.h b/source/blender/makesdna/DNA_meta_types.h index dc0ac7fd80c..53f563341b3 100644 --- a/source/blender/makesdna/DNA_meta_types.h +++ b/source/blender/makesdna/DNA_meta_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_meta_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef DNA_META_TYPES_H #define DNA_META_TYPES_H +/** \file DNA_meta_types.h + * \ingroup DNA + */ + #include "DNA_listBase.h" #include "DNA_ID.h" diff --git a/source/blender/makesdna/DNA_modifier_types.h b/source/blender/makesdna/DNA_modifier_types.h index b5bcd20a759..687a05f7afb 100644 --- a/source/blender/makesdna/DNA_modifier_types.h +++ b/source/blender/makesdna/DNA_modifier_types.h @@ -1,5 +1,4 @@ -/** - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -21,11 +20,16 @@ * ***** END GPL LICENSE BLOCK ***** */ -#include "DNA_listBase.h" - #ifndef DNA_MODIFIER_TYPES_H #define DNA_MODIFIER_TYPES_H +/** \file DNA_modifier_types.h + * \ingroup DNA + */ + +#include "DNA_listBase.h" + + #define MODSTACK_DEBUG 1 /* WARNING ALERT! TYPEDEF VALUES ARE WRITTEN IN FILES! SO DO NOT CHANGE! */ diff --git a/source/blender/makesdna/DNA_nla_types.h b/source/blender/makesdna/DNA_nla_types.h index 519d8ca8163..c64dda2afd0 100644 --- a/source/blender/makesdna/DNA_nla_types.h +++ b/source/blender/makesdna/DNA_nla_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +30,10 @@ #ifndef DNA_NLA_TYPES_H #define DNA_NLA_TYPES_H +/** \file DNA_nla_types.h + * \ingroup DNA + */ + #include "DNA_listBase.h" struct bAction; diff --git a/source/blender/makesdna/DNA_node_types.h b/source/blender/makesdna/DNA_node_types.h index 5fbbf4338c4..a9f688e29b9 100644 --- a/source/blender/makesdna/DNA_node_types.h +++ b/source/blender/makesdna/DNA_node_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +30,10 @@ #ifndef DNA_NODE_TYPES_H #define DNA_NODE_TYPES_H +/** \file DNA_node_types.h + * \ingroup DNA + */ + #include "DNA_ID.h" #include "DNA_vec_types.h" #include "DNA_listBase.h" diff --git a/source/blender/makesdna/DNA_object_fluidsim.h b/source/blender/makesdna/DNA_object_fluidsim.h index 700021eaceb..e8360b99d69 100644 --- a/source/blender/makesdna/DNA_object_fluidsim.h +++ b/source/blender/makesdna/DNA_object_fluidsim.h @@ -1,4 +1,4 @@ -/** +/* * * $Id$ * @@ -30,6 +30,10 @@ #ifndef DNA_OBJECT_FLUIDSIM_H #define DNA_OBJECT_FLUIDSIM_H +/** \file DNA_object_fluidsim.h + * \ingroup DNA + */ + #include "DNA_ID.h" #ifdef __cplusplus diff --git a/source/blender/makesdna/DNA_object_force.h b/source/blender/makesdna/DNA_object_force.h index 7656ae6372b..51076dd59a1 100644 --- a/source/blender/makesdna/DNA_object_force.h +++ b/source/blender/makesdna/DNA_object_force.h @@ -1,4 +1,4 @@ -/** +/* * * $Id$ * @@ -30,6 +30,10 @@ #ifndef DNA_OBJECT_FORCE_H #define DNA_OBJECT_FORCE_H +/** \file DNA_object_force.h + * \ingroup DNA + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/source/blender/makesdna/DNA_object_types.h b/source/blender/makesdna/DNA_object_types.h index 5ccb3e62f7d..8c0e065e27f 100644 --- a/source/blender/makesdna/DNA_object_types.h +++ b/source/blender/makesdna/DNA_object_types.h @@ -1,8 +1,4 @@ -/** - * blenlib/DNA_object_types.h (mar-2001 nzc) - * - * Object is a sort of wrapper for general info. - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -33,6 +29,11 @@ #ifndef DNA_OBJECT_TYPES_H #define DNA_OBJECT_TYPES_H +/** \file DNA_object_types.h + * \ingroup DNA + * \brief Object is a sort of wrapper for general info. + */ + #include "DNA_listBase.h" #include "DNA_ID.h" #include "DNA_action_types.h" /* bAnimVizSettings */ diff --git a/source/blender/makesdna/DNA_outliner_types.h b/source/blender/makesdna/DNA_outliner_types.h index d30351b6c34..c44f10efde8 100644 --- a/source/blender/makesdna/DNA_outliner_types.h +++ b/source/blender/makesdna/DNA_outliner_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +29,10 @@ #ifndef DNA_OUTLINER_TYPES_H #define DNA_OUTLINER_TYPES_H +/** \file DNA_outliner_types.h + * \ingroup DNA + */ + #include "DNA_listBase.h" struct ID; diff --git a/source/blender/makesdna/DNA_packedFile_types.h b/source/blender/makesdna/DNA_packedFile_types.h index 73f55ca186c..de7218ec704 100644 --- a/source/blender/makesdna/DNA_packedFile_types.h +++ b/source/blender/makesdna/DNA_packedFile_types.h @@ -1,7 +1,4 @@ -/* DNA_packedFile_types.h - * - * 12-oct-2000 nzc - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -33,6 +30,12 @@ #ifndef DNA_PACKEDFILE_TYPES_H #define DNA_PACKEDFILE_TYPES_H +/** \file DNA_packedFile_types.h + * \ingroup DNA + * \author nzc + * \since 12-oct-2000 nzc + */ + typedef struct PackedFile { int size; int seek; diff --git a/source/blender/makesdna/DNA_particle_types.h b/source/blender/makesdna/DNA_particle_types.h index d4590315c45..ae97b023e58 100644 --- a/source/blender/makesdna/DNA_particle_types.h +++ b/source/blender/makesdna/DNA_particle_types.h @@ -1,6 +1,4 @@ -/* DNA_particle_types.h - * - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -32,6 +30,10 @@ #ifndef DNA_PARTICLE_TYPES_H #define DNA_PARTICLE_TYPES_H +/** \file DNA_particle_types.h + * \ingroup DNA + */ + #include "DNA_ID.h" #include "DNA_boid_types.h" diff --git a/source/blender/makesdna/DNA_property_types.h b/source/blender/makesdna/DNA_property_types.h index e0da4e89f0f..025f79a6dbf 100644 --- a/source/blender/makesdna/DNA_property_types.h +++ b/source/blender/makesdna/DNA_property_types.h @@ -1,8 +1,5 @@ /** - * blenlib/DNA_property_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$ * @@ -34,6 +31,14 @@ #ifndef DNA_PROPERTY_TYPES_H #define DNA_PROPERTY_TYPES_H +/** \file DNA_property_types.h + * \ingroup DNA + * \since mar-2001 + * \author nzc + * \attention Renderrecipe and scene decription. The fact that there is a + * hierarchy here is a bit strange, and not desirable. + */ + /* ********************* PROPERTY ************************ */ typedef struct bProperty { diff --git a/source/blender/makesdna/DNA_scene_types.h b/source/blender/makesdna/DNA_scene_types.h index 8bf804bc9ab..59d6d3ceba6 100644 --- a/source/blender/makesdna/DNA_scene_types.h +++ b/source/blender/makesdna/DNA_scene_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +29,10 @@ #ifndef DNA_SCENE_TYPES_H #define DNA_SCENE_TYPES_H +/** \file DNA_scene_types.h + * \ingroup DNA + */ + // XXX, temp feature #define DURIAN_CAMERA_SWITCH diff --git a/source/blender/makesdna/DNA_screen_types.h b/source/blender/makesdna/DNA_screen_types.h index 52d8b2e8dd9..381046daedc 100644 --- a/source/blender/makesdna/DNA_screen_types.h +++ b/source/blender/makesdna/DNA_screen_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ #ifndef DNA_SCREEN_TYPES_H #define DNA_SCREEN_TYPES_H +/** \file DNA_screen_types.h + * \ingroup DNA + */ + #include "DNA_listBase.h" #include "DNA_view2d_types.h" #include "DNA_vec_types.h" diff --git a/source/blender/makesdna/DNA_sensor_types.h b/source/blender/makesdna/DNA_sensor_types.h index d2f6eb11952..fb7a3e70c7c 100644 --- a/source/blender/makesdna/DNA_sensor_types.h +++ b/source/blender/makesdna/DNA_sensor_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_sensor_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +28,12 @@ */ #ifndef DNA_SENSOR_TYPES_H #define DNA_SENSOR_TYPES_H +/** \file DNA_sensor_types.h + * \ingroup DNA + * \since mar-2001 + * \author nzc + * + */ struct Object; struct Material; diff --git a/source/blender/makesdna/DNA_sequence_types.h b/source/blender/makesdna/DNA_sequence_types.h index 4fcf7bd6250..22f0c23ea9b 100644 --- a/source/blender/makesdna/DNA_sequence_types.h +++ b/source/blender/makesdna/DNA_sequence_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_sequence_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +28,11 @@ */ #ifndef DNA_SEQUENCE_TYPES_H #define DNA_SEQUENCE_TYPES_H +/** \file DNA_sequence_types.h + * \ingroup DNA + * \since mar-2001 + * \author nzc + */ #include "DNA_listBase.h" #include "DNA_vec_types.h" diff --git a/source/blender/makesdna/DNA_smoke_types.h b/source/blender/makesdna/DNA_smoke_types.h index 0482c19e189..168481d3b29 100644 --- a/source/blender/makesdna/DNA_smoke_types.h +++ b/source/blender/makesdna/DNA_smoke_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +29,10 @@ #ifndef DNA_SMOKE_TYPES_H #define DNA_SMOKE_TYPES_H +/** \file DNA_smoke_types.h + * \ingroup DNA + */ + /* flags */ #define MOD_SMOKE_HIGHRES (1<<1) /* enable high resolution */ #define MOD_SMOKE_DISSOLVE (1<<2) /* let smoke dissolve */ diff --git a/source/blender/makesdna/DNA_sound_types.h b/source/blender/makesdna/DNA_sound_types.h index c10d306565b..3e5f82a8052 100644 --- a/source/blender/makesdna/DNA_sound_types.h +++ b/source/blender/makesdna/DNA_sound_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_sound_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +28,11 @@ */ #ifndef DNA_SOUND_TYPES_H #define DNA_SOUND_TYPES_H +/** \file DNA_sound_types.h + * \ingroup DNA + * \since mar-2001 + * \author nzc + */ #include "DNA_listBase.h" #include "DNA_ID.h" diff --git a/source/blender/makesdna/DNA_space_types.h b/source/blender/makesdna/DNA_space_types.h index 6cb7a186ca0..d6dbabafb0e 100644 --- a/source/blender/makesdna/DNA_space_types.h +++ b/source/blender/makesdna/DNA_space_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_space_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +28,11 @@ */ #ifndef DNA_SPACE_TYPES_H #define DNA_SPACE_TYPES_H +/** \file DNA_space_types.h + * \ingroup DNA + * \since mar-2001 + * \author nzc + */ #include "DNA_listBase.h" #include "DNA_color_types.h" /* for Histogram */ diff --git a/source/blender/makesdna/DNA_text_types.h b/source/blender/makesdna/DNA_text_types.h index 82de3fc1833..f805ced5dac 100644 --- a/source/blender/makesdna/DNA_text_types.h +++ b/source/blender/makesdna/DNA_text_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_text_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +28,11 @@ */ #ifndef DNA_TEXT_TYPES_H #define DNA_TEXT_TYPES_H +/** \file DNA_text_types.h + * \ingroup DNA + * \since mar-2001 + * \author nzc + */ #include "DNA_listBase.h" #include "DNA_ID.h" diff --git a/source/blender/makesdna/DNA_texture_types.h b/source/blender/makesdna/DNA_texture_types.h index c345eb34133..572a2282d45 100644 --- a/source/blender/makesdna/DNA_texture_types.h +++ b/source/blender/makesdna/DNA_texture_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_texture_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,12 @@ #ifndef DNA_TEXTURE_TYPES_H #define DNA_TEXTURE_TYPES_H +/** \file DNA_texture_types.h + * \ingroup DNA + * \since mar-2001 + * \author nzc + */ + #include "DNA_ID.h" #include "DNA_image_types.h" /* ImageUser */ diff --git a/source/blender/makesdna/DNA_userdef_types.h b/source/blender/makesdna/DNA_userdef_types.h index d8ab447b93a..c512b73c773 100644 --- a/source/blender/makesdna/DNA_userdef_types.h +++ b/source/blender/makesdna/DNA_userdef_types.h @@ -1,6 +1,4 @@ -/** - * blenkernel/DNA_userdef_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,12 @@ #ifndef DNA_USERDEF_TYPES_H #define DNA_USERDEF_TYPES_H +/** \file DNA_userdef_types.h + * \ingroup DNA + * \since mar-2001 + * \author nzc + * + */ #include "DNA_listBase.h" #include "DNA_texture_types.h" /* ColorBand */ diff --git a/source/blender/makesdna/DNA_vec_types.h b/source/blender/makesdna/DNA_vec_types.h index b5e3dff7db9..2d7804c3d1d 100644 --- a/source/blender/makesdna/DNA_vec_types.h +++ b/source/blender/makesdna/DNA_vec_types.h @@ -1,6 +1,4 @@ -/** - * vec_types.h dec 2000 Nzc - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -32,12 +30,20 @@ #ifndef DNA_VEC_TYPES_H #define DNA_VEC_TYPES_H +/** \file DNA_vec_types.h + * \ingroup DNA + * \since dec-2000 + * \author nzc + */ /* types */ + +/** vector of two shorts. */ typedef struct vec2s { short x, y; } vec2s; +/** vector of two floats. */ typedef struct vec2f { float x, y; } vec2f; @@ -77,11 +83,13 @@ typedef struct vec4d { } vec4d; */ +/** integer rectangle. */ typedef struct rcti { int xmin, xmax; int ymin, ymax; } rcti; +/** float rectangle. */ typedef struct rctf { float xmin, xmax; float ymin, ymax; diff --git a/source/blender/makesdna/DNA_vfont_types.h b/source/blender/makesdna/DNA_vfont_types.h index e342ef1cd79..ec576055b55 100644 --- a/source/blender/makesdna/DNA_vfont_types.h +++ b/source/blender/makesdna/DNA_vfont_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_vfont_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,12 @@ #ifndef DNA_VFONT_TYPES_H #define DNA_VFONT_TYPES_H +/** \file DNA_vfont_types.h + * \ingroup DNA + * \since mar-2001 + * \author nzc + */ + #include "DNA_ID.h" struct PackedFile; diff --git a/source/blender/makesdna/DNA_view2d_types.h b/source/blender/makesdna/DNA_view2d_types.h index 75ad1e644d1..ac1d3409153 100644 --- a/source/blender/makesdna/DNA_view2d_types.h +++ b/source/blender/makesdna/DNA_view2d_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_view2d_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef DNA_VIEW2D_TYPES_H #define DNA_VIEW2D_TYPES_H +/** \file DNA_view2d_types.h + * \ingroup DNA + */ + #include "DNA_vec_types.h" /* ---------------------------------- */ diff --git a/source/blender/makesdna/DNA_view3d_types.h b/source/blender/makesdna/DNA_view3d_types.h index d429f55eb6c..3ffef475e1b 100644 --- a/source/blender/makesdna/DNA_view3d_types.h +++ b/source/blender/makesdna/DNA_view3d_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_view3d_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef DNA_VIEW3D_TYPES_H #define DNA_VIEW3D_TYPES_H +/** \file DNA_view3d_types.h + * \ingroup DNA + */ + struct ViewDepths; struct Object; struct Image; diff --git a/source/blender/makesdna/DNA_windowmanager_types.h b/source/blender/makesdna/DNA_windowmanager_types.h index f47ea06645b..958c9cffc84 100644 --- a/source/blender/makesdna/DNA_windowmanager_types.h +++ b/source/blender/makesdna/DNA_windowmanager_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,6 +28,10 @@ #ifndef DNA_WINDOWMANAGER_TYPES_H #define DNA_WINDOWMANAGER_TYPES_H +/** \file DNA_windowmanager_types.h + * \ingroup DNA + */ + #include "DNA_listBase.h" #include "DNA_vec_types.h" diff --git a/source/blender/makesdna/DNA_world_types.h b/source/blender/makesdna/DNA_world_types.h index 68b3c32db97..71d907f1c12 100644 --- a/source/blender/makesdna/DNA_world_types.h +++ b/source/blender/makesdna/DNA_world_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_world_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +29,10 @@ #ifndef DNA_WORLD_TYPES_H #define DNA_WORLD_TYPES_H +/** \file DNA_world_types.h + * \ingroup DNA + */ + #include "DNA_ID.h" struct AnimData; -- cgit v1.2.3