[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [34962] trunk/blender: doxygen: blenkernel under core as module.
Nathan Letwory
nathan at letworyinteractive.com
Fri Feb 18 14:05:20 CET 2011
Revision: 34962
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=34962
Author: jesterking
Date: 2011-02-18 13:05:18 +0000 (Fri, 18 Feb 2011)
Log Message:
-----------
doxygen: blenkernel under core as module.
Modified Paths:
--------------
trunk/blender/doc/Doxyfile
trunk/blender/doc/doxygen.main
trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h
trunk/blender/source/blender/blenkernel/BKE_action.h
trunk/blender/source/blender/blenkernel/BKE_anim.h
trunk/blender/source/blender/blenkernel/BKE_animsys.h
trunk/blender/source/blender/blenkernel/BKE_armature.h
trunk/blender/source/blender/blenkernel/BKE_array_mallocn.h
trunk/blender/source/blender/blenkernel/BKE_blender.h
trunk/blender/source/blender/blenkernel/BKE_bmesh.h
trunk/blender/source/blender/blenkernel/BKE_bmeshCustomData.h
trunk/blender/source/blender/blenkernel/BKE_bmfont.h
trunk/blender/source/blender/blenkernel/BKE_bmfont_types.h
trunk/blender/source/blender/blenkernel/BKE_boids.h
trunk/blender/source/blender/blenkernel/BKE_booleanops_mesh.h
trunk/blender/source/blender/blenkernel/BKE_brush.h
trunk/blender/source/blender/blenkernel/BKE_bullet.h
trunk/blender/source/blender/blenkernel/BKE_bvhutils.h
trunk/blender/source/blender/blenkernel/BKE_cdderivedmesh.h
trunk/blender/source/blender/blenkernel/BKE_cloth.h
trunk/blender/source/blender/blenkernel/BKE_collision.h
trunk/blender/source/blender/blenkernel/BKE_colortools.h
trunk/blender/source/blender/blenkernel/BKE_constraint.h
trunk/blender/source/blender/blenkernel/BKE_context.h
trunk/blender/source/blender/blenkernel/BKE_curve.h
trunk/blender/source/blender/blenkernel/BKE_customdata.h
trunk/blender/source/blender/blenkernel/BKE_customdata_file.h
trunk/blender/source/blender/blenkernel/BKE_deform.h
trunk/blender/source/blender/blenkernel/BKE_depsgraph.h
trunk/blender/source/blender/blenkernel/BKE_displist.h
trunk/blender/source/blender/blenkernel/BKE_effect.h
trunk/blender/source/blender/blenkernel/BKE_endian.h
trunk/blender/source/blender/blenkernel/BKE_exotic.h
trunk/blender/source/blender/blenkernel/BKE_fcurve.h
trunk/blender/source/blender/blenkernel/BKE_fluidsim.h
trunk/blender/source/blender/blenkernel/BKE_font.h
trunk/blender/source/blender/blenkernel/BKE_global.h
trunk/blender/source/blender/blenkernel/BKE_gpencil.h
trunk/blender/source/blender/blenkernel/BKE_group.h
trunk/blender/source/blender/blenkernel/BKE_icons.h
trunk/blender/source/blender/blenkernel/BKE_idcode.h
trunk/blender/source/blender/blenkernel/BKE_idprop.h
trunk/blender/source/blender/blenkernel/BKE_image.h
trunk/blender/source/blender/blenkernel/BKE_ipo.h
trunk/blender/source/blender/blenkernel/BKE_key.h
trunk/blender/source/blender/blenkernel/BKE_lattice.h
trunk/blender/source/blender/blenkernel/BKE_library.h
trunk/blender/source/blender/blenkernel/BKE_main.h
trunk/blender/source/blender/blenkernel/BKE_material.h
trunk/blender/source/blender/blenkernel/BKE_mball.h
trunk/blender/source/blender/blenkernel/BKE_mesh.h
trunk/blender/source/blender/blenkernel/BKE_modifier.h
trunk/blender/source/blender/blenkernel/BKE_multires.h
trunk/blender/source/blender/blenkernel/BKE_nla.h
trunk/blender/source/blender/blenkernel/BKE_node.h
trunk/blender/source/blender/blenkernel/BKE_object.h
trunk/blender/source/blender/blenkernel/BKE_packedFile.h
trunk/blender/source/blender/blenkernel/BKE_paint.h
trunk/blender/source/blender/blenkernel/BKE_particle.h
trunk/blender/source/blender/blenkernel/BKE_plugin_types.h
trunk/blender/source/blender/blenkernel/BKE_pointcache.h
trunk/blender/source/blender/blenkernel/BKE_property.h
trunk/blender/source/blender/blenkernel/BKE_report.h
trunk/blender/source/blender/blenkernel/BKE_sca.h
trunk/blender/source/blender/blenkernel/BKE_scene.h
trunk/blender/source/blender/blenkernel/BKE_screen.h
trunk/blender/source/blender/blenkernel/BKE_script.h
trunk/blender/source/blender/blenkernel/BKE_sequencer.h
trunk/blender/source/blender/blenkernel/BKE_shrinkwrap.h
trunk/blender/source/blender/blenkernel/BKE_sketch.h
trunk/blender/source/blender/blenkernel/BKE_smoke.h
trunk/blender/source/blender/blenkernel/BKE_softbody.h
trunk/blender/source/blender/blenkernel/BKE_sound.h
trunk/blender/source/blender/blenkernel/BKE_subsurf.h
trunk/blender/source/blender/blenkernel/BKE_suggestions.h
trunk/blender/source/blender/blenkernel/BKE_text.h
trunk/blender/source/blender/blenkernel/BKE_texture.h
trunk/blender/source/blender/blenkernel/BKE_unit.h
trunk/blender/source/blender/blenkernel/BKE_utildefines.h
trunk/blender/source/blender/blenkernel/BKE_world.h
trunk/blender/source/blender/blenkernel/BKE_writeavi.h
trunk/blender/source/blender/blenkernel/BKE_writeffmpeg.h
trunk/blender/source/blender/blenkernel/BKE_writeframeserver.h
Modified: trunk/blender/doc/Doxyfile
===================================================================
--- trunk/blender/doc/Doxyfile 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/doc/Doxyfile 2011-02-18 13:05:18 UTC (rev 34962)
@@ -624,7 +624,8 @@
../source/blender/makesrna \
../intern/ghost \
../source/blender/blenloader \
- ../source/blender/readblenfile
+ ../source/blender/readblenfile \
+ ../source/blender/blenkernel
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
Modified: trunk/blender/doc/doxygen.main
===================================================================
--- trunk/blender/doc/doxygen.main 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/doc/doxygen.main 2011-02-18 13:05:18 UTC (rev 34962)
@@ -72,6 +72,16 @@
* \todo add to doxygen
*/
+/** \defgroup core core */
+
+/** \defgroup bke blenkernel
+ * \ingroup core
+ */
+
+/** \defgroup bli blenlib
+ * \ingroup core
+ */
+
/** \defgroup data DNA, RNA and .blend access*/
/** \defgroup GHOST GHOST API */
Modified: trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -30,15 +30,17 @@
#ifndef BKE_DERIVEDMESH_H
#define BKE_DERIVEDMESH_H
-/* TODO (Probably)
+/** \file BKE_DerivedMesh.h
+ * \ingroup bke
*
- * o Make drawMapped* functions take a predicate function that
+ * \todo
+ * - Make drawMapped* functions take a predicate function that
* determines whether to draw the edge (this predicate can
* also set color, etc). This will be slightly more general
* and allow some of the functions to be collapsed.
- * o Once accessor functions are added then single element draw
+ * - Once accessor functions are added then single element draw
* functions can be implemented using primitive accessors.
- * o Add function to dispatch to renderer instead of using
+ * - Add function to dispatch to renderer instead of using
* conversion to DLM.
*/
Modified: trunk/blender/source/blender/blenkernel/BKE_action.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_action.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_action.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -1,9 +1,4 @@
-/* BKE_action.h May 2001
- *
- * Blender kernel action and pose functionality
- *
- * Reevan McKay
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -33,6 +28,14 @@
#ifndef BKE_ACTION_H
#define BKE_ACTION_H
+/** \file BKE_action.h
+ * \ingroup bke
+ * \brief Blender kernel action and pose functionality.
+ * \author Reevan McKay
+ * \author Ton Roosendaal (full recode 2005)
+ * \author Joshua Leung (full recode 2009)
+ * \since may 2001
+ */
#include "DNA_listBase.h"
Modified: trunk/blender/source/blender/blenkernel/BKE_anim.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_anim.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_anim.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_anim.h (mar-2001 nzc);
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -31,6 +29,11 @@
#ifndef BKE_ANIM_H
#define BKE_ANIM_H
+/** \file BKE_anim.h
+ * \ingroup bke
+ * \author nzc
+ * \since March 2001
+ */
struct Path;
struct Object;
struct PartEff;
Modified: trunk/blender/source/blender/blenkernel/BKE_animsys.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_animsys.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_animsys.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -28,6 +28,11 @@
#ifndef BKE_ANIM_SYS_H
#define BKE_ANIM_SYS_H
+/** \file BKE_animsys.h
+ * \ingroup bke
+ * \author Joshua Leung
+ */
+
struct ID;
struct ListBase;
struct Main;
Modified: trunk/blender/source/blender/blenkernel/BKE_armature.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_armature.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_armature.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BKE_armature.h (mar-2001 nzc)
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -31,6 +29,12 @@
#ifndef BKE_ARMATURE_H
#define BKE_ARMATURE_H
+/** \file BKE_armature.h
+ * \ingroup bke
+ * \since March 2001
+ * \author nzc
+ */
+
struct Bone;
struct Main;
struct bArmature;
Modified: trunk/blender/source/blender/blenkernel/BKE_array_mallocn.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_array_mallocn.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_array_mallocn.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -30,8 +30,13 @@
#ifndef BKE_ARRAY_MALLOCN_H
#define BKE_ARRAY_MALLOCN_H
-/*little array macro library. example of usage:
+/** \file BKE_array_mallocn.h
+ * \ingroup bke
+ * \brief little array macro library.
+ */
+/* example of usage:
+
int *arr = NULL;
V_DECLARE(arr);
int i;
Modified: trunk/blender/source/blender/blenkernel/BKE_blender.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_blender.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_blender.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -1,8 +1,4 @@
-/**
- * blenlib/BKE_blender.h (mar-2001 nzc)
- *
- * Blender util stuff?
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -33,6 +29,13 @@
#ifndef BKE_BLENDER_H
#define BKE_BLENDER_H
+/** \file BKE_blender.h
+ * \ingroup bke
+ * \since March 2001
+ * \author nzc
+ * \brief Blender util stuff
+ */
+
#ifdef __cplusplus
extern "C" {
#endif
Modified: trunk/blender/source/blender/blenkernel/BKE_bmesh.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_bmesh.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_bmesh.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -1,8 +1,4 @@
-/**
- * BKE_bmesh.h jan 2007
- *
- * BMesh modeler structure and functions.
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -37,6 +33,13 @@
#ifndef BKE_BMESH_H
#define BKE_BMESH_H
+/** \file BKE_bmesh.h
+ * \ingroup bke
+ * \since January 2007
+ * \brief BMesh modeler structure and functions.
+ *
+ */
+
#include "DNA_listBase.h"
#include "BLI_utildefines.h"
#include "BLI_ghash.h"
Modified: trunk/blender/source/blender/blenkernel/BKE_bmeshCustomData.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_bmeshCustomData.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_bmeshCustomData.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -1,8 +1,4 @@
-/**
- * BKE_bmesh.h jan 2007
- *
- * BMesh modeler structure and functions.
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -38,6 +34,12 @@
#ifndef BKE_BMESHCUSTOMDATA_H
#define BKE_BMESHCUSTOMDATA_H
+/** \file BKE_bmeshCustomData.h
+ * \ingroup bke
+ * \since January 2007
+ * \brief BMesh modeler structure and functions - custom data.
+ */
+
struct BLI_mempool;
/*Custom Data Types and defines
Modified: trunk/blender/source/blender/blenkernel/BKE_bmfont.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_bmfont.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_bmfont.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -1,8 +1,4 @@
-/**
- * blenlib/BKE_bmfont.h (mar-2001 nzc)
- *
- *
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -33,6 +29,12 @@
#ifndef BKE_BMFONT_H
#define BKE_BMFONT_H
+/** \file BKE_bmfont.h
+ * \ingroup bke
+ * \since March 2001
+ * \author nzc
+ */
+
#ifdef __cplusplus
extern "C" {
#endif
Modified: trunk/blender/source/blender/blenkernel/BKE_bmfont_types.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_bmfont_types.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_bmfont_types.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -1,8 +1,4 @@
-/**
- * blenlib/BKE_bmfont_types.h (mar-2001 nzc)
- *
- *
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -33,6 +29,11 @@
#ifndef BKE_BMFONT_TYPES_H
#define BKE_BMFONT_TYPES_H
+/** \file BKE_bmfont_types.h
+ * \ingroup bke
+ * \since March 2001
+ * \author nzc
+ */
#define is_power_of_two(N) ((N ^ (N - 1)) == (2 * N - 1))
/*
Moved to IMB_imbuf_types.h where it will live close to the ImBuf type.
Modified: trunk/blender/source/blender/blenkernel/BKE_boids.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_boids.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_boids.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -1,6 +1,4 @@
-/* BKE_particle.h
- *
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -32,6 +30,12 @@
#ifndef BKE_BOIDS_H
#define BKE_BOIDS_H
+/** \file BKE_boids.h
+ * \ingroup bke
+ * \since 2009
+ * \author Janne Karhu
+ */
+
#include "DNA_boid_types.h"
typedef struct BoidBrainData {
Modified: trunk/blender/source/blender/blenkernel/BKE_booleanops_mesh.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_booleanops_mesh.h 2011-02-18 12:56:43 UTC (rev 34961)
+++ trunk/blender/source/blender/blenkernel/BKE_booleanops_mesh.h 2011-02-18 13:05:18 UTC (rev 34962)
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +29,10 @@
#ifndef BKE_PyBooleanOps_h
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list