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 7d4d3d7c333b56904864a22ff7b71f72d20f3359..267283ee47aca418c171848afc179eb3be09bbba 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 e09d7635f75aff5ec83647393ded8bab850012ac..31e02ff1877e46ab65bca6481c88f7a6a9812328 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 68375615614eab288942355352d23214f56aacf1..3547101612fa0d4fd2a94c36bc24906e9aa27cbc 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 83f8f4d01993746b056f70ac398fbfff8ebe075d..8ce6b0cc2bb48ecb42cfaa58630793bd0991209e 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 6ddad214af4d585f31c22d1b498bf8fe22f91801..3693f43b69e2c903d5862c46c0b384db5f4e003b 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 11c8533783eeba7a318ec6f0c70d5b99fb495cb7..4ebd7318ea87c43b0332a1acb5729784c99acb29 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 9b9f0ede52630508178abd7e20f1d2ebf656337d..1f78366287ff476a84ce6feeb6dccf246fdbacc5 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 83cd7979ce74acf6d0f4f42e07d5b833e0ba9a50..3b5a18658326e1e9efe5663557d9b8594dc49953 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 275ffd93ae53036ac3513fc8998204b23b89950f..1d752fce4ef66aa4f7c2d2eab5723ffe5e504a6a 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 fcd5587b14bc1f3a65b12a8396852e4fbf0cd709..e48386e5c4e62a13b83058e616954ae4ae03d3db 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 d66246a4136bff1006fabf29857149f29cecec66..b51612037fc6bd0fe1fb36c6a9cbf229ab13fe3d 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 4f8dd0317cb22274fd4d2a1c3bd69f0a05642443..cdfcf465c6cd92ad684cfa33e37de872e742c7b2 100644 (file)
@@ -27,7 +27,7 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-/** @file DNA_customdata_types.h
+/** \file DNA_customdata_types.h
  *  \ingroup DNA
  */
 
index ee0b791a27431ee7732ecc12c81f740dac28cc1c..f87698a3d64572f35d83664a229ed3fbee8e9182 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 0c3a9429de6e33ebf900c6cc5729f3085538eec2..9aa3e1eb3c1605a10e8d41f78761a2d6aa8cd268 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 8e00a89af093b71ed80adef22fe23e68ac93d136..e8ed65802064a86a6cde69908a1458c42f00deb7 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 25378173929f1cb83e3ef9fc1dfe08f82569d5d9..ffccc08048edf4a6005422fcda262be686516dce 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 7416f6ea397fb252ed3f35973bf158a162ebee0e..106b85a53728d3895476ec57cc3071b5f02453b3 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 3df3c8b41c61c5176bced27aee8873967f3bf8b3..99ed2319415a1a46b92b5939016ab9eaa6e54f37 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 d0554a7aaa529aa2596737bd59f7086c6867b173..5dba9154a3a279cc383012ed3d61a7958f2b8e19 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 3cdb5c7ebd94de071a5bc739ac05d14444f50ce2..2d5960aa309ffbe44435e40e4290cb1ecfb4e70f 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 1028d733c65e77750ca3c6f2351ae74f86592e37..9377b5d8a09792df99f1fba0e82788dfe423b9a1 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 bf2ada51155e0000ae4eaab461291a66160451a9..662ef9e8a453d4e8b58f95b1e21b3213f5b1547c 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 afeb79037f57741f1972316bbdf5b9364cb4615c..f52325c0e7b4042257256dc1e4a968045bee5e5a 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 5a117d59f8acaba39b5df61aaac370eeed2554d8..860da1d80a443812371343944a361b03718953d9 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 853c123e5d74c9f0feba6d3f01102acd8afb789a..bd2a6a996b554fbb6446fe77399ce388d8934959 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 9761eda5de76f1594797e9708c4d0306a3be7142..e3510b3a25adf5a6b5aca04fc6728fe2022cd9f1 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 dc0ac7fd80c40b783d36a8f5b927929ab54cb4f6..53f563341b319a3eb08f8e6665fdececaad90370 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 b5bcd20a7596ed351906d7cbf00dea391b501b58..687a05f7afb410a2750fea5fb4db20eb45a36666 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 519d8ca816374a1ee6a07b35ed73a98a18897092..c64dda2afd0bfca68a0457c34d37f46857e77d76 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 5fbbf4338c410792c5dc2b8402b1f12f862948b4..a9f688e29b90ad8a337be89f712cda27435acc9c 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 700021eaceb17eb29de153c5d2beb05c794a2c6c..e8360b99d69fe0cd2f3e970f8228a50ecb908660 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 7656ae6372b6284f2c33c3d3c0646987b82a6114..51076dd59a1c5f674b4c60898eec3bdaf8a6f8b0 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 5ccb3e62f7df5b2e59f6ab893352759f681b817e..8c0e065e27feb0b3cb661e05f1ea989da0a7ad87 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 d30351b6c34e754c6d0ba27a3aa7ce0e959a183f..c44f10efde870e4f3d5346c4de14974c9620be4e 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 73f55ca186c9688996627e37731056d428fe4eae..de7218ec704ab8a31858b183e33d770b643fdadc 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 d4590315c45fc70de97099f72c2284e277509d0b..ae97b023e5883588500386c882f769e3e081bc19 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 e0da4e89f0f6b29a40288a86788b4d1165709d7d..025f79a6dbfae4909d539f020f60cb168119c905 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 8bf804bc9ab6992adb03d16fab801e6c9b1bfcd9..59d6d3ceba6626538fcbf32c2b5fb1cac7a163d2 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 52d8b2e8dd9259c3653d6974dbc65424d515627a..381046daedc022b971b93dc6f4adce69c2013874 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 d2f6eb119527d82907d1924dfe49cd4f0cbf1d73..fb7a3e70c7c4c6203153900fe6efb5f6adcae5c8 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 4fcf7bd62506108c1f7bd6f98f4202c8b7c659af..22f0c23ea9bc4213d88bf21d8acb47d05680c752 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 0482c19e18989a274ba205c04accd0493075ef94..168481d3b29fbb020f07c046c2d11af29bdc8c9a 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 c10d306565b350f111ada257d269550eefe9f6e4..3e5f82a805256479546116a4c71d01ab2db93a9e 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 6cb7a186ca0fd077fe498ee28dea688fae6dc59e..d6dbabafb0ed1297ea4ec6d9ce5de7039ba6fb4d 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 82de3fc183387410275a55706d2584191f3c9300..f805ced5dac579ca87eeca0a4674af653d2c6be4 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 c345eb34133d18cf7419e80f54a58c4f3e6edf1d..572a2282d45e77c3657d984d9a4928c551141b37 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 d8ab447b93ad7d1d8e0e65d40207209f949f927c..c512b73c773d8c64bfa0f74d46d4f9370561a34b 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 b5e3dff7db9da3f5f4ce584effadc458786b8fa0..2d7804c3d1d0dafd7f09a3e12f1414305e0a4d23 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 e342ef1cd79560dadf61c0d1c4b4294243ce9799..ec576055b55e0c24ba0a3cc847cd75dc6800c82e 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 75ad1e644d102f95d08f46b66c9aa8953f48042e..ac1d3409153af7531a17afe021d224e0b6593346 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 d429f55eb6c526929b98ea5959196bce744dbe8a..3ffef475e1b35cb9c046ec7f6498318e467a96f3 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 f47ea06645bf46ddc966b35d07d3944117301ebe..958c9cffc841046eca0fb299cd60ee8543602200 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 68b3c32db970678caf9a5d3e7a609cbaadfce275..71d907f1c122e42e2b07facf1f92ee377ea80ce4 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;