diff options
author | Nathan Letwory <nathan@letworyinteractive.com> | 2011-02-17 08:57:18 +0300 |
---|---|---|
committer | Nathan Letwory <nathan@letworyinteractive.com> | 2011-02-17 08:57:18 +0300 |
commit | f336b80d7f142121edc21f3bd77a9e241f1aecaa (patch) | |
tree | ca87c79d5469f1fa3698172f9e0972581c2a795e /source/blender/makesdna | |
parent | 812f23849422e50b2834434c11072de8eb8bda7e (diff) |
Starting work on doxygen cleanup. Many things still to be done.
Diffstat (limited to 'source/blender/makesdna')
-rw-r--r-- | source/blender/makesdna/DNA_action_types.h | 4 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_actuator_types.h | 15 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_customdata_types.h | 10 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_documentation.h | 28 | ||||
-rw-r--r-- | source/blender/makesdna/intern/makesdna.c | 14 |
5 files changed, 44 insertions, 27 deletions
diff --git a/source/blender/makesdna/DNA_action_types.h b/source/blender/makesdna/DNA_action_types.h index 17f9afce7c3..1618da90392 100644 --- a/source/blender/makesdna/DNA_action_types.h +++ b/source/blender/makesdna/DNA_action_types.h @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file DNA_action_types.h + * \ingroup DNA + */ + #ifndef DNA_ACTION_TYPES_H #define DNA_ACTION_TYPES_H diff --git a/source/blender/makesdna/DNA_actuator_types.h b/source/blender/makesdna/DNA_actuator_types.h index 20fdb5eee41..4f7be73e7fa 100644 --- a/source/blender/makesdna/DNA_actuator_types.h +++ b/source/blender/makesdna/DNA_actuator_types.h @@ -1,6 +1,4 @@ -/** - * blenlib/DNA_actuator_types.h (mar-2001 nzc) - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file DNA_actuator_types.h + * \ingroup DNA + */ + #ifndef DNA_ACTUATOR_TYPES_H #define DNA_ACTUATOR_TYPES_H @@ -227,19 +230,19 @@ typedef struct bActuator { struct bActuator *next, *prev, *mynew; short type; /** - * Tells what type of actuator data <data> holds. + * Tells what type of actuator data \ref data holds. */ short flag; short otype, go; char name[32]; /** - * Data must point to an object actuator type struct. + * \var Data must point to an object actuator type struct. */ void *data; /** - * For ipo's and props: to find out which object the actuator + * \var For ipo's and props: to find out which object the actuator * belongs to */ struct Object *ob; diff --git a/source/blender/makesdna/DNA_customdata_types.h b/source/blender/makesdna/DNA_customdata_types.h index 6c0b4db221d..4f8dd0317cb 100644 --- a/source/blender/makesdna/DNA_customdata_types.h +++ b/source/blender/makesdna/DNA_customdata_types.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** @file DNA_customdata_types.h + * \ingroup DNA + */ + #ifndef DNA_CUSTOMDATA_TYPES_H #define DNA_CUSTOMDATA_TYPES_H @@ -34,7 +38,7 @@ extern "C" { #endif -/* descriptor and storage for a custom data layer */ +/** descriptor and storage for a custom data layer */ typedef struct CustomDataLayer { int type; /* type of data in layer */ int offset; /* in editmode, offset of layer in block */ @@ -52,7 +56,7 @@ typedef struct CustomDataExternal { char filename[240]; /* FILE_MAX */ } CustomDataExternal; -/* structure which stores custom element data associated with mesh elements +/** structure which stores custom element data associated with mesh elements * (vertices, edges or faces). The custom data is organised into a series of * layers, each with a data type (e.g. MTFace, MDeformVert, etc.). */ typedef struct CustomData { diff --git a/source/blender/makesdna/DNA_documentation.h b/source/blender/makesdna/DNA_documentation.h index a911b92c313..cfca99fff6d 100644 --- a/source/blender/makesdna/DNA_documentation.h +++ b/source/blender/makesdna/DNA_documentation.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,29 +25,32 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** + */ + +/*! + * \ingroup DNA + * \page makesdna makesdna * - * @mainpage DNA- Makesdna modules - * - * @section about About the DNA module + * @section aboutdna About the DNA module * * The DNA module holds all type definitions that are serialized in a * blender file. There is an executable that scans all files, looking - * for struct-s to serialize (hence sdna: Struct DNA). From this + * for struct-s to serialize (hence sdna: Struct \ref DNA). From this * information, it builds a file with numbers that encode the format, * the names of variables, and the plce to look for them. * - * @section issues Known issues with DNA + * @section dnaissues Known issues with DNA * * - Function pointers: * * Because of historical reasons, some function pointers were * untyped. The parser/dna generator has been modified to explicitly * handle these special cases. Most pointers have been given proper - * proto's by now. DNA_space_types.h::Spacefile::returnfuncmay still + * proto's by now. DNA_space_types.h::Spacefile::returnfunc may still * be badly defined. The reason for this is that it is called with * different types of arguments. It takes a char* at this moment... * - * - Path to the header files + * - %Path to the header files * * Also because of historical reasons, there is a path prefix to the * headers that need to be scanned. This is the BASE_HEADER @@ -55,20 +58,19 @@ * have to change this (Not very flexible, but it is hardly ever * changed. Sorry.). * - * @section dependencies Dependencies + * @section dnadependencies Dependencies * * DNA has no external dependencies (except for a few system * includes). - * - **/ + * @section dnanote NOTE -/* PLEASE READ INSTRUCTIONS ABOUT ADDING VARIABLES IN 'DNA' STRUCTS IN + PLEASE READ INSTRUCTIONS ABOUT ADDING VARIABLES IN 'DNA' STRUCTS IN intern/dna_genfile.c (ton) - */ + **/ diff --git a/source/blender/makesdna/intern/makesdna.c b/source/blender/makesdna/intern/makesdna.c index 7762ce170df..471a1b86825 100644 --- a/source/blender/makesdna/intern/makesdna.c +++ b/source/blender/makesdna/intern/makesdna.c @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,8 +25,9 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * - * Struct muncher for making SDNA + */ + +/** Struct muncher for making SDNA * * Originally by Ton, some mods by Frank, and some cleaning and * extension by Nzc. @@ -160,12 +161,15 @@ int additional_slen_offset; /* ************************************************************************** */ /** - * Add type <str> to struct indexed by <len>, if it was not yet found. + * Add type \c str to struct indexed by \c len, if it was not yet found. + * \param str char + * \param len int */ int add_type(const char *str, int len); /** - * Add variable <str> to + * Add variable \c str to + * \param str */ int add_name(char *str); |