[Bf-blender-cvs] [5d30c23] master: doxygen: corrections/updates
Campbell Barton
noreply at git.blender.org
Wed May 20 06:15:43 CEST 2015
Commit: 5d30c23c35aafba3a9bc772b4e66dd70b1ed84de
Author: Campbell Barton
Date: Wed May 20 12:54:45 2015 +1000
Branches: master
https://developer.blender.org/rB5d30c23c35aafba3a9bc772b4e66dd70b1ed84de
doxygen: corrections/updates
Also add depsgraph & physics
===================================================================
M doc/doxygen/doxygen.intern.h
M doc/doxygen/doxygen.source.h
M extern/bullet2/src/BulletCollision/CollisionDispatch/btCollisionWorld.h
M intern/ghost/intern/GHOST_SystemX11.h
M intern/iksolver/extern/IK_solver.h
M intern/memutil/MEM_CacheLimiter.h
M intern/memutil/MEM_RefCountPtr.h
M intern/memutil/MEM_SmartPtr.h
M source/blender/avi/AVI_avi.h
M source/blender/blenkernel/BKE_mesh.h
M source/blender/blenkernel/intern/dynamicpaint.c
M source/blender/blenkernel/intern/mesh_evaluate.c
M source/blender/blenkernel/intern/object_deform.c
M source/blender/blenlib/intern/BLI_dynstr.c
M source/blender/blenlib/intern/convexhull2d.c
M source/blender/blenlib/intern/edgehash.c
M source/blender/blenlib/intern/gsqueue.c
M source/blender/blenlib/intern/string_utf8.c
M source/blender/blenlib/intern/timecode.c
M source/blender/blenloader/BLO_readfile.h
M source/blender/blenloader/intern/writefile.c
M source/blender/bmesh/intern/bmesh_core.c
M source/blender/bmesh/intern/bmesh_mods.c
M source/blender/bmesh/tools/bmesh_decimate_collapse.c
M source/blender/bmesh/tools/bmesh_edgenet.c
M source/blender/bmesh/tools/bmesh_edgesplit.c
M source/blender/bmesh/tools/bmesh_wireframe.c
M source/blender/compositor/COM_compositor.h
M source/blender/depsgraph/DEG_depsgraph.h
M source/blender/depsgraph/DEG_depsgraph_build.h
M source/blender/depsgraph/DEG_depsgraph_debug.h
M source/blender/depsgraph/DEG_depsgraph_query.h
M source/blender/depsgraph/intern/depsgraph.cc
M source/blender/depsgraph/intern/depsgraph.h
M source/blender/depsgraph/intern/depsgraph_build.cc
M source/blender/depsgraph/intern/depsgraph_build.h
M source/blender/depsgraph/intern/depsgraph_build_nodes.cc
M source/blender/depsgraph/intern/depsgraph_build_relations.cc
M source/blender/depsgraph/intern/depsgraph_debug.cc
M source/blender/depsgraph/intern/depsgraph_debug.h
M source/blender/depsgraph/intern/depsgraph_eval.cc
M source/blender/depsgraph/intern/depsgraph_intern.h
M source/blender/depsgraph/intern/depsgraph_query.cc
M source/blender/depsgraph/intern/depsgraph_queue.cc
M source/blender/depsgraph/intern/depsgraph_queue.h
M source/blender/depsgraph/intern/depsgraph_tag.cc
M source/blender/depsgraph/intern/depsgraph_type_defines.cc
M source/blender/depsgraph/intern/depsgraph_types.h
M source/blender/depsgraph/intern/depsnode.cc
M source/blender/depsgraph/intern/depsnode.h
M source/blender/depsgraph/intern/depsnode_component.cc
M source/blender/depsgraph/intern/depsnode_component.h
M source/blender/depsgraph/intern/depsnode_opcodes.h
M source/blender/depsgraph/intern/depsnode_operation.cc
M source/blender/depsgraph/intern/depsnode_operation.h
M source/blender/depsgraph/util/depsgraph_util_cycle.cc
M source/blender/depsgraph/util/depsgraph_util_cycle.h
M source/blender/depsgraph/util/depsgraph_util_function.h
M source/blender/depsgraph/util/depsgraph_util_hash.h
M source/blender/depsgraph/util/depsgraph_util_map.h
M source/blender/depsgraph/util/depsgraph_util_pchanmap.cc
M source/blender/depsgraph/util/depsgraph_util_pchanmap.h
M source/blender/depsgraph/util/depsgraph_util_set.h
M source/blender/depsgraph/util/depsgraph_util_transitive.cc
M source/blender/depsgraph/util/depsgraph_util_transitive.h
M source/blender/editors/interface/view2d.c
M source/blender/editors/sculpt_paint/sculpt.c
M source/blender/imbuf/IMB_imbuf.h
M source/blender/physics/BPH_mass_spring.h
M source/blender/physics/intern/eigen_utils.h
M source/gameengine/Expressions/PyObjectPlus.cpp
===================================================================
diff --git a/doc/doxygen/doxygen.intern.h b/doc/doxygen/doxygen.intern.h
index ae8f6ca..2c8ecae 100644
--- a/doc/doxygen/doxygen.intern.h
+++ b/doc/doxygen/doxygen.intern.h
@@ -10,26 +10,14 @@
* \ingroup intern
*/
-/** \defgroup boolop boolop
- * \ingroup intern
- */
-
/** \defgroup ctr container
* \ingroup intern
*/
-/** \defgroup decimation decimation
- * \ingroup intern
- */
-
/** \defgroup elbeem elbeem
* \ingroup intern
*/
-/** \defgroup bsp bsp
- * \ingroup intern
- */
-
/** \defgroup iksolver iksolver
* \ingroup intern
*/
diff --git a/doc/doxygen/doxygen.source.h b/doc/doxygen/doxygen.source.h
index f27a5a8..42516b9 100644
--- a/doc/doxygen/doxygen.source.h
+++ b/doc/doxygen/doxygen.source.h
@@ -93,36 +93,44 @@
/* ================================ */
-/** \defgroup blender blender */
+/** \defgroup blender Blender */
-/** \defgroup blf blenfont
+/** \defgroup blf BlenFont
* \ingroup blender
*/
-/** \defgroup bke blenkernel
+/** \defgroup bke BlenKernel
* \ingroup blender
*/
-/** \defgroup bli blenlib
+/** \defgroup bli BlenLib
* \ingroup blender
*/
-/** \defgroup nodes nodes
+/** \defgroup depsgraph Dependency Graph
* \ingroup blender
*/
-/** \defgroup cmpnodes cmpnodes
+/** \defgroup bph Physics
+ * \ingroup blender
+ */
+
+/** \defgroup nodes Nodes
+ * \ingroup blender
+ */
+
+/** \defgroup cmpnodes Nodes (Compositor)
* \ingroup nodes
*/
-/** \defgroup shdnodes shdnodes
+/** \defgroup shdnodes Nodes (Shader)
* \ingroup nodes
*/
-/** \defgroup texnodes texnodes
+/** \defgroup texnodes Nodes (Texture)
* \ingroup nodes
*/
-/** \defgroup modifiers modifiers
+/** \defgroup modifiers Object Modifiers
* \ingroup blender
*/
@@ -132,29 +140,29 @@
* \ingroup blender
*/
-/** \defgroup ikplugin ikplugin
+/** \defgroup ikplugin IK Plugin
* \ingroup blender
*/
-/** \defgroup DNA sDNA
+/** \defgroup DNA Struct DNA (File Format)
* \ingroup blender data
*/
-/** \defgroup RNA RNA
+/** \defgroup RNA RNA (Data API)
* \ingroup blender data
*/
-/** \defgroup blenloader .blend read and write functions
+/** \defgroup blenloader Blend file IO
* \ingroup blender data
* \todo check if \ref blo and \ref blenloader groups can be
* merged in docs.
*/
-/** \defgroup quicktime quicktime
+/** \defgroup quicktime QuickTime
* \ingroup blender
/** \defgroup gui GUI */
-/** \defgroup wm windowmanager
+/** \defgroup wm Window Manager
* \ingroup blender gui
*/
@@ -324,7 +332,7 @@
* \ingroup externformats
*/
-/** \defgroup imbuf IMage Buffer
+/** \defgroup imbuf Image Buffer (ImBuf)
* \ingroup blender
*/
diff --git a/extern/bullet2/src/BulletCollision/CollisionDispatch/btCollisionWorld.h b/extern/bullet2/src/BulletCollision/CollisionDispatch/btCollisionWorld.h
index b3fffde..0ac5563 100644
--- a/extern/bullet2/src/BulletCollision/CollisionDispatch/btCollisionWorld.h
+++ b/extern/bullet2/src/BulletCollision/CollisionDispatch/btCollisionWorld.h
@@ -15,7 +15,7 @@ subject to the following restrictions:
/**
- * @mainpage Bullet Documentation
+ * @page Bullet Documentation
*
* @section intro_sec Introduction
* Bullet is a Collision Detection and Rigid Body Dynamics Library. The Library is Open Source and free for commercial use, under the ZLib license ( http://opensource.org/licenses/zlib-license.php ).
diff --git a/intern/ghost/intern/GHOST_SystemX11.h b/intern/ghost/intern/GHOST_SystemX11.h
index a5c1329..6c0784d 100644
--- a/intern/ghost/intern/GHOST_SystemX11.h
+++ b/intern/ghost/intern/GHOST_SystemX11.h
@@ -157,10 +157,6 @@ public:
);
/**
- * \section Interface Inherited from GHOST_ISystem
- */
-
- /**
* Retrieves events from the system and stores them in the queue.
* \param waitForEvent Flag to wait for an event (or return immediately).
* \return Indication of the presence of events.
@@ -170,9 +166,6 @@ public:
bool waitForEvent
);
- /**
- * \section Interface Inherited from GHOST_System
- */
GHOST_TSuccess
getCursorPosition(
GHOST_TInt32& x,
@@ -206,7 +199,6 @@ public:
) const;
/**
- * \section Interface Dirty
* Flag a window as dirty. This will
* generate a GHOST window update event on a call to processEvents()
*/
diff --git a/intern/iksolver/extern/IK_solver.h b/intern/iksolver/extern/IK_solver.h
index 4de9f14..5522380 100644
--- a/intern/iksolver/extern/IK_solver.h
+++ b/intern/iksolver/extern/IK_solver.h
@@ -35,10 +35,10 @@
* Copyright (C) 2001 NaN Technologies B.V.
*
- * @author Laurence, Brecht
- * @mainpage IK - Blender inverse kinematics module.
+ * \author Laurence, Brecht
+ * \page IK - Blender inverse kinematics module.
*
- * @section about About the IK module
+ * \section about About the IK module
*
* This module allows you to create segments and form them into
* tree. You can then define a goal points that the end of a given
@@ -47,7 +47,7 @@
* to get the as near as possible to the goal. This solver uses an
* inverse jacobian method to find a solution.
*
- * @section issues Known issues with this IK solver.
+ * \section issues Known issues with this IK solver.
*
* - There is currently no support for joint constraints in the
* solver. This is within the realms of possibility - please ask
@@ -60,7 +60,7 @@
* Other algorithms exist which are more suitable for real-time
* applications, please ask if this functionality is required.
*
- * @section dependencies Dependencies
+ * \section dependencies Dependencies
*
* This module only depends on Moto.
*/
diff --git a/intern/memutil/MEM_CacheLimiter.h b/intern/memutil/MEM_CacheLimiter.h
index 3e8ae7e..d5a4437 100644
--- a/intern/memutil/MEM_CacheLimiter.h
+++ b/intern/memutil/MEM_CacheLimiter.h
@@ -29,20 +29,22 @@
#define __MEM_CACHELIMITER_H__
/**
- * @section MEM_CacheLimiter
+ * \section MEM_CacheLimiter
* This class defines a generic memory cache management system
* to limit memory usage to a fixed global maximum.
*
- * Please use the C-API in MEM_CacheLimiterC-Api.h for code written in C.
+ * \note Please use the C-API in MEM_CacheLimiterC-Api.h for code written in C.
*
* Usage example:
*
+ * \code{.cpp}
* class BigFatImage {
* public:
* ~BigFatImage() { tell_everyone_we_are_gone(this); }
* };
*
- * void doit() {
+ * void doit()
+ * {
* MEM_Cache<BigFatImage> BigFatImages;
*
* MEM_Cache_Handle<BigFatImage>* h = BigFatImages.insert(new BigFatImage);
@@ -50,11 +52,12 @@
* BigFatImages.enforce_limits();
* h->ref();
*
- * work with image...
+ * // work with image...
*
* h->unref();
*
- * leave image in cache.
+ * // leave image in cache.
+ * \endcode
*/
#include <list>
diff --git a/intern/memutil/MEM_RefCountPtr.h b/intern/memutil/MEM_RefCountPtr.h
index da10e68..ea865ea 100644
--- a/intern/memutil/MEM_RefCountPtr.h
+++ b/intern/memutil/MEM_RefCountPtr.h
@@ -30,9 +30,9 @@
*/
/**
- * @file MEM_RefCountPtr.h
+ * \file MEM_RefCountPtr.h
* Declaration of MEM_RefCounted and MEM_RefCountable classes.
- * @author Laurence
+ * \author Laurence
*/
#ifndef __MEM_REFCOUNTPTR_H__
@@ -41,7 +41,7 @@
#include <stdlib.h> // for NULL !
/**
- * @section MEM_RefCountable
+ * \section MEM_RefCountable
* This is a base class for reference countable objects.
* If you want an object to be shared using a reference
* counted system derrivce from this class. All subclasses
@@ -50,9 +50,9 @@
* defining a static New() method that returns a ref counted
* ptr to a new()ly allocated instance.
*
- * @section Example subclass
- *
+ * \section Example subclass
*
+ * \code{.cpp}
* class MySharedObject : public MEM_RefCountable {
*
* private :
@@ -68,6 +68,7 @@
*
* // other member functions
* };
+ * \endcode
*
* Alternitively you may first wish to define a fully functional
* class and then define a reference counting wrapper for this class.
@@ -75,6 +76,8 @@
* counting.
*
* E.g.
+ *
+ * \code{.cpp}
* class UsefullClass {
* private :
* ...
@@ -108,7 +111,7 @@
* // mechanism to handle object lifetime.
* ~RcUsefullClass();
* };
- *
+ * \endcode
*
*/
@@ -168,7 +171,7 @@ public :
};
/**
- * @section MEM_RefCountPtr
+ * \section MEM_RefCountPtr
*/
template
diff --git a/intern/memutil/MEM_SmartPtr.h b/intern/memutil/MEM_SmartPtr.h
index dd19aae..e0d7b812 100644
--- a/intern/memutil/MEM_SmartPtr.h
+++ b/intern/memutil/MEM_SmartPtr.h
@@ -43,7 +43,7 @@
/**
- * @section MEM_SmartPtr
+ * \section MEM_SmartPtr
* This class defines a smart pointer similar to that defined in
* the Standard Template Library but without the painful get()
* semantics to access the internal c style pointer.
@@ -58,8 +58,9 @@
* should not be shared. This is not reliably enforceable in C++
* but this class attempts to make the 1-1 relationship clear.
*
- * @section Example usage
+ * \section Example usage
*
+ * \code{.cpp}
* class foo {
* ...constructors accessors etc.
* int x[1000];
@@ -86,18 +87,21 @@
* private :
* MEM_SmartPtr<foo> m_foo;
* }
+ * \endcode
*
* You may also safely construct vectors of MEM_SmartPtrs and
* have the vector own stuff you put into it.
*
* e.g.
+ * \code{.cpp}
* {
- * std::vector<MEM_SmartPtr<foo> > foo_vector;
- * foo_vector.push_back( new foo());
- * foo_vector.push_back( new foo());
+ * std::vector<MEM_SmartPtr<foo> > foo_vector;
+ * foo_vector.push_back( new foo());
+ * foo_vector.push_back( new foo());
*
- * foo_vector[0]->bla();
+ * foo_vector[0]->bla();
* } // foo_vector out of scope => heap memory freed for both foos
+ * \endcode
*
* @warning this class should only be used for objects created
* on the heap via the new function. It will not behave correctly
diff --git a/source/blender/avi/AVI_avi.h b/source/blender/avi/AVI_avi.h
index 44ffaad..5e9fe37 100644
--- a/source/blender/avi/AVI_avi.h
+++ b/source/blender/avi/AVI_avi.h
@@ -28,18 +28,17 @@
/** \file AVI_avi.h
* \ingroup avi
- * \section aviabout AVI module external interface
*
- * \subsection about About the AVI module
+ * \section avi_about About the AVI
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list