Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/source
diff options
context:
space:
mode:
authorNathan Letwory <nathan@letworyinteractive.com>2011-02-17 19:17:40 +0300
committerNathan Letwory <nathan@letworyinteractive.com>2011-02-17 19:17:40 +0300
commitf697247f0e567f87dcce76fa389c9b6a62fcef6a (patch)
tree4301e4852dd7387392466a827825e2c9aebf8a9e /source
parent8a63ee46ba4114a17916e6ab45cab061365e83c7 (diff)
Start simple intros for intern and extern libs.
Some reorg of modules/pages, start makesdna and makesrna. In many places license block needs to be changed to not start with /**, because otherwise documentation will go weird.
Diffstat (limited to 'source')
-rw-r--r--source/blender/makesdna/DNA_documentation.h14
-rw-r--r--source/blender/makesdna/DNA_sdna_types.h8
-rw-r--r--source/blender/makesdna/intern/makesdna.c10
-rw-r--r--source/blender/makesrna/RNA_documentation.h2
4 files changed, 20 insertions, 14 deletions
diff --git a/source/blender/makesdna/DNA_documentation.h b/source/blender/makesdna/DNA_documentation.h
index cfca99fff6d..2e5eb3778c4 100644
--- a/source/blender/makesdna/DNA_documentation.h
+++ b/source/blender/makesdna/DNA_documentation.h
@@ -27,11 +27,11 @@
* ***** END GPL LICENSE BLOCK *****
*/
-/*!
- * \ingroup DNA
+/**
* \page makesdna makesdna
+ * \ingroup DNA
*
- * @section aboutdna 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
@@ -39,7 +39,7 @@
* information, it builds a file with numbers that encode the format,
* the names of variables, and the plce to look for them.
*
- * @section dnaissues Known issues with DNA
+ * \section dnaissues Known issues with DNA
*
* - Function pointers:
*
@@ -58,19 +58,19 @@
* have to change this (Not very flexible, but it is hardly ever
* changed. Sorry.).
*
- * @section dnadependencies Dependencies
+ * \section dnadependencies Dependencies
*
* DNA has no external dependencies (except for a few system
* includes).
- * @section dnanote NOTE
+ * \section dnanote NOTE
PLEASE READ INSTRUCTIONS ABOUT ADDING VARIABLES IN 'DNA' STRUCTS IN
intern/dna_genfile.c
(ton)
- **/
+ */
diff --git a/source/blender/makesdna/DNA_sdna_types.h b/source/blender/makesdna/DNA_sdna_types.h
index 8e291035be7..e5f924b5fa6 100644
--- a/source/blender/makesdna/DNA_sdna_types.h
+++ b/source/blender/makesdna/DNA_sdna_types.h
@@ -1,6 +1,4 @@
-/**
- * blenlib/DNA_sdna.h (mar-2001 nzc)
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -30,6 +28,10 @@
*/
#ifndef DNA_SDNA_H
#define DNA_SDNA_H
+/**
+ * \file DNA_sdna_types.h
+ * \ingroup DNA
+ */
#
#
diff --git a/source/blender/makesdna/intern/makesdna.c b/source/blender/makesdna/intern/makesdna.c
index 471a1b86825..50083a3472c 100644
--- a/source/blender/makesdna/intern/makesdna.c
+++ b/source/blender/makesdna/intern/makesdna.c
@@ -27,8 +27,11 @@
* ***** END GPL LICENSE BLOCK *****
*/
-/** Struct muncher for making SDNA
+/** \file makesdna.c
+ * \brief Struct muncher for making SDNA.
+ * \ingroup DNA
*
+ * \section aboutmakesdnac About makesdna tool
* Originally by Ton, some mods by Frank, and some cleaning and
* extension by Nzc.
*
@@ -43,7 +46,7 @@
* and the offsets for reaching a particular one.
*
* There is a facility to get verbose output from sdna. Search for
- * debugSDNA. This int can be set to 0 (no output) to some int. Higher
+ * \ref debugSDNA. This int can be set to 0 (no output) to some int. Higher
* numbers give more output.
* */
@@ -146,7 +149,8 @@ short **structs, *structdata; /* at sp= structs[a] is the first address of a str
sp[0] is type number
sp[1] is amount of elements
sp[2] sp[3] is typenr, namenr (etc) */
-/*
+/**
+ * Variable to control debug output of makesdna.
* debugSDNA:
* - 0 = no output, except errors
* - 1 = detail actions
diff --git a/source/blender/makesrna/RNA_documentation.h b/source/blender/makesrna/RNA_documentation.h
index aef1f19bf8b..de8e2336bf2 100644
--- a/source/blender/makesrna/RNA_documentation.h
+++ b/source/blender/makesrna/RNA_documentation.h
@@ -1,4 +1,4 @@
-/*! \page makesrna makesrna
+/** \page makesrna makesrna
* \ingroup RNA
* \section aboutmakesrna About RNA
* The \ref RNA module defines and provides the access API to the data, thus encapsulating \ref DNA