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/DNA_documentation.h | |
| parent | 812f23849422e50b2834434c11072de8eb8bda7e (diff) | |
Starting work on doxygen cleanup. Many things still to be done.
Diffstat (limited to 'source/blender/makesdna/DNA_documentation.h')
| -rw-r--r-- | source/blender/makesdna/DNA_documentation.h | 28 |
1 files changed, 15 insertions, 13 deletions
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) - */ + **/ |