DNA header files are now grouped under the same module. No further documentation...
authorNathan Letwory <nathan@letworyinteractive.com>
Thu, 17 Feb 2011 20:48:12 +0000 (20:48 +0000)
committerNathan Letwory <nathan@letworyinteractive.com>
Thu, 17 Feb 2011 20:48:12 +0000 (20:48 +0000)
53 files changed:
source/blender/makesdna/DNA_ID.h
source/blender/makesdna/DNA_anim_types.h
source/blender/makesdna/DNA_armature_types.h
source/blender/makesdna/DNA_boid_types.h
source/blender/makesdna/DNA_brush_types.h
source/blender/makesdna/DNA_camera_types.h
source/blender/makesdna/DNA_cloth_types.h
source/blender/makesdna/DNA_color_types.h
source/blender/makesdna/DNA_constraint_types.h
source/blender/makesdna/DNA_controller_types.h
source/blender/makesdna/DNA_curve_types.h
source/blender/makesdna/DNA_customdata_types.h
source/blender/makesdna/DNA_effect_types.h
source/blender/makesdna/DNA_fileglobal_types.h
source/blender/makesdna/DNA_genfile.h
source/blender/makesdna/DNA_gpencil_types.h
source/blender/makesdna/DNA_group_types.h
source/blender/makesdna/DNA_image_types.h
source/blender/makesdna/DNA_ipo_types.h
source/blender/makesdna/DNA_key_types.h
source/blender/makesdna/DNA_lamp_types.h
source/blender/makesdna/DNA_lattice_types.h
source/blender/makesdna/DNA_listBase.h
source/blender/makesdna/DNA_material_types.h
source/blender/makesdna/DNA_mesh_types.h
source/blender/makesdna/DNA_meshdata_types.h
source/blender/makesdna/DNA_meta_types.h
source/blender/makesdna/DNA_modifier_types.h
source/blender/makesdna/DNA_nla_types.h
source/blender/makesdna/DNA_node_types.h
source/blender/makesdna/DNA_object_fluidsim.h
source/blender/makesdna/DNA_object_force.h
source/blender/makesdna/DNA_object_types.h
source/blender/makesdna/DNA_outliner_types.h
source/blender/makesdna/DNA_packedFile_types.h
source/blender/makesdna/DNA_particle_types.h
source/blender/makesdna/DNA_property_types.h
source/blender/makesdna/DNA_scene_types.h
source/blender/makesdna/DNA_screen_types.h
source/blender/makesdna/DNA_sensor_types.h
source/blender/makesdna/DNA_sequence_types.h
source/blender/makesdna/DNA_smoke_types.h
source/blender/makesdna/DNA_sound_types.h
source/blender/makesdna/DNA_space_types.h
source/blender/makesdna/DNA_text_types.h
source/blender/makesdna/DNA_texture_types.h
source/blender/makesdna/DNA_userdef_types.h
source/blender/makesdna/DNA_vec_types.h
source/blender/makesdna/DNA_vfont_types.h
source/blender/makesdna/DNA_view2d_types.h
source/blender/makesdna/DNA_view3d_types.h
source/blender/makesdna/DNA_windowmanager_types.h
source/blender/makesdna/DNA_world_types.h

index 7d4d3d7..267283e 100644 (file)
@@ -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 *****
 #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
index e09d763..31e02ff 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_ANIM_TYPES_H
 #define DNA_ANIM_TYPES_H
 
+/** \file DNA_anim_types.h
+ *  \ingroup DNA
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index 6837561..3547101 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
 
index 83f8f4d..8ce6b0c 100644 (file)
@@ -1,6 +1,4 @@
-/* DNA_particle_types.h
- *
- *
+/* 
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_BOID_TYPES_H
 #define DNA_BOID_TYPES_H
 
+/** \file DNA_boid_types.h
+ *  \ingroup DNA
+ */
+
 #include "DNA_listBase.h"
 
 typedef enum BoidRuleType {
index 6ddad21..3693f43 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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 */
 
index 11c8533..4ebd731 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_camera_types.h (mar-2001 nzc)
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_CAMERA_TYPES_H
 #define DNA_CAMERA_TYPES_H
 
+/** \file DNA_camera_types.h
+ *  \ingroup DNA
+ */
+
 #include "DNA_ID.h"
 
 #ifdef __cplusplus
index 9b9f0ed..1f78366 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
 * $Id$
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 #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
index 83cd797..3b5a186 100644 (file)
@@ -1,5 +1,4 @@
-/**
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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 */
index 275ffd9..1d752fc 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
 
index fcd5587..e48386e 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_controller_types.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_CONTROLLER_TYPES_H
 #define DNA_CONTROLLER_TYPES_H
 
+/** \file DNA_controller_types.h
+ *  \ingroup DNA
+ */
+
 struct bActuator;
 struct Text;
 struct bSensor;
index d66246a..b516120 100644 (file)
@@ -1,8 +1,4 @@
-/**
- * blenlib/DNA_curve_types.h (mar-2001 nzc)
- *
- * Curve stuff.
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
index 4f8dd03..cdfcf46 100644 (file)
@@ -27,7 +27,7 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-/** @file DNA_customdata_types.h
+/** \file DNA_customdata_types.h
  *  \ingroup DNA
  */
 
index ee0b791..f87698a 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_effect_types.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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
index 0c3a942..9aa3e1e 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_fileglobal_types.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_FILEGLOBAL_TYPES_H
 #define DNA_FILEGLOBAL_TYPES_H
 
+/** \file DNA_fileglobal_types.h
+ *  \ingroup DNA
+ */
+
 struct bScreen;
 struct Scene;
 
index 8e00a89..e8ed658 100644 (file)
  * 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 */
index 2537817..ffccc08 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
 
index 7416f6e..106b85a 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * blenlib/DNA_group_types.h (mar-2001 nzc)
  *     
  * $Id$ 
 #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"
 
index 3df3c8b..99ed231 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_image_types.h (mar-2001 nzc)
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_IMAGE_TYPES_H
 #define DNA_IMAGE_TYPES_H
 
+/** \file DNA_image_types.h
+ *  \ingroup DNA
+ */
+
 #include "DNA_ID.h"
 
 struct PackedFile;
index d0554a7..5dba915 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_ipo_types.h (mar-2001 nzc)
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  * ***** 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
index 3cdb5c7..2d5960a 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_key_types.h (mar-2001 nzc)
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
 
index 1028d73..9377b5d 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_lamp_types.h (mar-2001 nzc)
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_LAMP_TYPES_H
 #define DNA_LAMP_TYPES_H
 
+/** \file DNA_lamp_types.h
+ *  \ingroup DNA
+ */
+
 #include "DNA_ID.h"
 
 #ifndef MAX_MTEX
index bf2ada5..662ef9e 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_LATTICE_TYPES_H
 #define DNA_LATTICE_TYPES_H
 
+/** \file DNA_lattice_types.h
+ *  \ingroup DNA
+ */
+
 #include "DNA_ID.h"
 
 struct AnimData;
index afeb790..f52325c 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BLI_listBase.h    mar 2001 Nzc
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** 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
index 5a117d5..860da1d 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_material_types.h (mar-2001 nzc)
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
 
index 853c123..bd2a6a9 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
index 9761eda..e3510b3 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
 
index dc0ac7f..53f5633 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_meta_types.h (mar-2001 nzc)
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
 
index b5bcd20..687a05f 100644 (file)
@@ -1,5 +1,4 @@
-/**
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  * ***** 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! */
index 519d8ca..c64dda2 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_NLA_TYPES_H
 #define DNA_NLA_TYPES_H
 
+/** \file DNA_nla_types.h
+ *  \ingroup DNA
+ */
+
 #include "DNA_listBase.h"
 
 struct bAction;
index 5fbbf43..a9f688e 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
index 700021e..e8360b9 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  *
  * $Id$
  *
 #ifndef DNA_OBJECT_FLUIDSIM_H
 #define DNA_OBJECT_FLUIDSIM_H
 
+/** \file DNA_object_fluidsim.h
+ *  \ingroup DNA
+ */
+
 #include "DNA_ID.h"
 
 #ifdef __cplusplus
index 7656ae6..51076dd 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  *
  * $Id$
  *
 #ifndef DNA_OBJECT_FORCE_H
 #define DNA_OBJECT_FORCE_H
 
+/** \file DNA_object_force.h
+ *  \ingroup DNA
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index 5ccb3e6..8c0e065 100644 (file)
@@ -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 *****
 #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 */
index d30351b..c44f10e 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_OUTLINER_TYPES_H
 #define DNA_OUTLINER_TYPES_H
 
+/** \file DNA_outliner_types.h
+ *  \ingroup DNA
+ */
+
 #include "DNA_listBase.h"
 
 struct ID;
index 73f55ca..de7218e 100644 (file)
@@ -1,7 +1,4 @@
-/* DNA_packedFile_types.h 
- * 
- * 12-oct-2000 nzc
- * 
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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;
index d459031..ae97b02 100644 (file)
@@ -1,6 +1,4 @@
-/* DNA_particle_types.h
- *
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
 
index e0da4e8..025f79a 100644 (file)
@@ -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$ 
  *
 #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 {
index 8bf804b..59d6d3c 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_SCENE_TYPES_H
 #define DNA_SCENE_TYPES_H
 
+/** \file DNA_scene_types.h
+ *  \ingroup DNA
+ */
+
 // XXX, temp feature
 #define DURIAN_CAMERA_SWITCH
 
index 52d8b2e..381046d 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
index d2f6eb1..fb7a3e7 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_sensor_types.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  */
 #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;
index 4fcf7bd..22f0c23 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_sequence_types.h (mar-2001 nzc)
- *
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  */
 #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"
index 0482c19..168481d 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
 * $Id$
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 #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 */
index c10d306..3e5f82a 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_sound_types.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  */
 #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"
index 6cb7a18..d6dbaba 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_space_types.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  */
 #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 */
index 82de3fc..f805ced 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_text_types.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  */
 #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"
index c345eb3..572a228 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_texture_types.h (mar-2001 nzc)
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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 */
 
index d8ab447..c512b73 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenkernel/DNA_userdef_types.h (mar-2001 nzc)
- *
+/*
  *     $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 
 #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 */
index b5e3dff..2d7804c 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * vec_types.h    dec 2000 Nzc
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 
 #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;
index e342ef1..ec57605 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_vfont_types.h (mar-2001 nzc)
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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;
index 75ad1e6..ac1d340 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_view2d_types.h (mar-2001 nzc)
- *     
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_VIEW2D_TYPES_H
 #define DNA_VIEW2D_TYPES_H
 
+/** \file DNA_view2d_types.h
+ *  \ingroup DNA
+ */
+
 #include "DNA_vec_types.h"
 
 /* ---------------------------------- */
index d429f55..3ffef47 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_view3d_types.h (mar-2001 nzc)
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_VIEW3D_TYPES_H
 #define DNA_VIEW3D_TYPES_H
 
+/** \file DNA_view3d_types.h
+ *  \ingroup DNA
+ */
+
 struct ViewDepths;
 struct Object;
 struct Image;
index f47ea06..958c9cf 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #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"
 
index 68b3c32..71d907f 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_world_types.h (mar-2001 nzc)
- *
+/*
  * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
 #ifndef DNA_WORLD_TYPES_H
 #define DNA_WORLD_TYPES_H
 
+/** \file DNA_world_types.h
+ *  \ingroup DNA
+ */
+
 #include "DNA_ID.h"
 
 struct AnimData;