[Bf-blender-cvs] [f6fd3a84c2e] master: Cleanup: reorganize doxygen modules

Campbell Barton noreply at git.blender.org
Tue Dec 14 11:04:38 CET 2021 

Commit: f6fd3a84c2ea12e14aff8769ee631e305212a7f8
Author: Campbell Barton
Date:   Tue Dec 14 18:35:31 2021 +1100
Branches: master
https://developer.blender.org/rBf6fd3a84c2ea12e14aff8769ee631e305212a7f8

Cleanup: reorganize doxygen modules

- Nest compositor pages under the compositor module
- Nest GUI, DNA/RNA & externformats modules under Blender.
- Remove modules from intern which no longer exist.
- Add intern modules (atomic, eigen, glew-mx, libc_compat, locale,
  numaapi, rigidbody, sky, utfconv).
- Use 'intern_' prefix for intern modules since some of the modules
  use generic terms such as locale & atomic.

===================================================================

M	doc/doxygen/doxygen.intern.h
M	doc/doxygen/doxygen.source.h
M	intern/atomic/atomic_ops.h
M	intern/atomic/intern/atomic_ops_ext.h
M	intern/atomic/intern/atomic_ops_msvc.h
M	intern/atomic/intern/atomic_ops_unix.h
M	intern/atomic/intern/atomic_ops_utils.h
M	intern/clog/CLG_log.h
M	intern/clog/clog.c
M	intern/eigen/eigen_capi.h
M	intern/eigen/intern/eigenvalues.h
M	intern/eigen/intern/linear_solver.cc
M	intern/eigen/intern/linear_solver.h
M	intern/eigen/intern/matrix.cc
M	intern/eigen/intern/matrix.h
M	intern/eigen/intern/svd.cc
M	intern/eigen/intern/svd.h
M	intern/glew-mx/glew-mx.h
M	intern/glew-mx/intern/gl-deprecated.h
M	intern/glew-mx/intern/glew-mx.c
M	intern/glew-mx/intern/symbol-binding.h
M	intern/guardedalloc/MEM_guardedalloc.h
M	intern/guardedalloc/cpp/mallocn.cpp
M	intern/guardedalloc/intern/leak_detector.cc
M	intern/guardedalloc/intern/mallocn.c
M	intern/guardedalloc/intern/mallocn_guarded_impl.c
M	intern/guardedalloc/intern/mallocn_inline.h
M	intern/guardedalloc/intern/mallocn_intern.h
M	intern/guardedalloc/intern/mallocn_lockfree_impl.c
M	intern/iksolver/extern/IK_solver.h
M	intern/iksolver/intern/IK_Math.h
M	intern/iksolver/intern/IK_QJacobian.cpp
M	intern/iksolver/intern/IK_QJacobian.h
M	intern/iksolver/intern/IK_QJacobianSolver.cpp
M	intern/iksolver/intern/IK_QJacobianSolver.h
M	intern/iksolver/intern/IK_QSegment.cpp
M	intern/iksolver/intern/IK_QSegment.h
M	intern/iksolver/intern/IK_QTask.cpp
M	intern/iksolver/intern/IK_QTask.h
M	intern/iksolver/intern/IK_Solver.cpp
M	intern/itasc/Armature.cpp
M	intern/itasc/Cache.cpp
M	intern/itasc/ConstraintSet.cpp
M	intern/itasc/ControlledObject.cpp
M	intern/itasc/CopyPose.cpp
M	intern/itasc/Distance.cpp
M	intern/itasc/FixedObject.cpp
M	intern/itasc/MovingFrame.cpp
M	intern/itasc/Scene.cpp
M	intern/itasc/UncontrolledObject.cpp
M	intern/itasc/WDLSSolver.cpp
M	intern/itasc/WSDLSSolver.cpp
M	intern/itasc/WorldObject.cpp
M	intern/itasc/eigen_types.cpp
M	intern/itasc/kdl/chain.cpp
M	intern/itasc/kdl/chainfksolverpos_recursive.cpp
M	intern/itasc/kdl/chainjnttojacsolver.cpp
M	intern/itasc/kdl/frameacc.cpp
M	intern/itasc/kdl/frames.cpp
M	intern/itasc/kdl/frames_io.cpp
M	intern/itasc/kdl/framevel.cpp
M	intern/itasc/kdl/inertia.cpp
M	intern/itasc/kdl/jacobian.cpp
M	intern/itasc/kdl/jntarray.cpp
M	intern/itasc/kdl/jntarrayacc.cpp
M	intern/itasc/kdl/jntarrayvel.cpp
M	intern/itasc/kdl/joint.cpp
M	intern/itasc/kdl/kinfam_io.cpp
M	intern/itasc/kdl/segment.cpp
M	intern/itasc/kdl/tree.cpp
M	intern/itasc/kdl/treefksolverpos_recursive.cpp
M	intern/itasc/kdl/treejnttojacsolver.cpp
M	intern/itasc/kdl/utilities/error_stack.cpp
M	intern/itasc/kdl/utilities/kdl-config.h
M	intern/itasc/kdl/utilities/traits.h
M	intern/itasc/kdl/utilities/utility.cpp
M	intern/itasc/kdl/utilities/utility_io.cpp
M	intern/libc_compat/libc_compat.c
M	intern/locale/boost_locale_wrapper.cpp
M	intern/locale/boost_locale_wrapper.h
M	intern/locale/osx_user_locale.mm
M	intern/mantaflow/extern/manta_fluid_API.h
M	intern/mantaflow/extern/manta_python_API.h
M	intern/mantaflow/intern/MANTA_main.cpp
M	intern/mantaflow/intern/MANTA_main.h
M	intern/mantaflow/intern/manta_fluid_API.cpp
M	intern/mantaflow/intern/manta_python_API.cpp
M	intern/mantaflow/intern/strings/fluid_script.h
M	intern/mantaflow/intern/strings/liquid_script.h
M	intern/mantaflow/intern/strings/smoke_script.h
M	intern/memutil/MEM_Allocator.h
M	intern/memutil/MEM_CacheLimiter.h
M	intern/memutil/MEM_CacheLimiterC-Api.h
M	intern/memutil/MEM_RefCounted.h
M	intern/memutil/MEM_RefCountedC-Api.h
M	intern/memutil/intern/MEM_CacheLimiterC-Api.cpp
M	intern/memutil/intern/MEM_RefCountedC-Api.cpp
M	intern/numaapi/include/numaapi.h
M	intern/numaapi/source/build_config.h
M	intern/numaapi/source/numaapi.c
M	intern/numaapi/source/numaapi_linux.c
M	intern/numaapi/source/numaapi_stub.c
M	intern/numaapi/source/numaapi_win32.c
M	intern/rigidbody/RBI_api.h
M	intern/rigidbody/RBI_hull_api.h
M	intern/rigidbody/rb_bullet_api.cpp
M	intern/rigidbody/rb_convex_hull_api.cpp
M	intern/sky/include/sky_model.h
M	intern/sky/source/sky_float3.h
M	intern/sky/source/sky_model.cpp
M	intern/sky/source/sky_model_data.h
M	intern/sky/source/sky_nishita.cpp
M	intern/utfconv/utf_winfunc.c
M	intern/utfconv/utf_winfunc.h
M	intern/utfconv/utfconv.c
M	intern/utfconv/utfconv.h
M	source/blender/compositor/COM_compositor.h

===================================================================

diff --git a/doc/doxygen/doxygen.intern.h b/doc/doxygen/doxygen.intern.h
index b08b868a7e3..b6145e22a90 100644
--- a/doc/doxygen/doxygen.intern.h
+++ b/doc/doxygen/doxygen.intern.h
@@ -6,91 +6,90 @@
  *  as part of the normal development process.
  */
 
-/** \defgroup MEM Guarded memory (de)allocation
- *  \ingroup intern
+/* TODO: other modules.
+ * - `libmv`
+ * - `cycles`
+ * - `opencolorio`
+ * - `opensubdiv`
+ * - `openvdb`
+ * - `quadriflow`
  */
 
-/** \defgroup clog C-Logging (CLOG)
- *  \ingroup intern
- */
+/** \defgroup intern_atomic Atomic Operations
+ *  \ingroup intern */
 
-/** \defgroup ctr container
- *  \ingroup intern
- */
+/** \defgroup intern_clog C-Logging (CLOG)
+ *  \ingroup intern */
 
-/** \defgroup iksolver iksolver
- *  \ingroup intern
- */
+/** \defgroup intern_eigen Eigen
+ *  \ingroup intern */
 
-/** \defgroup itasc itasc
- *  \ingroup intern
- */
+/** \defgroup intern_glew-mx GLEW with Multiple Rendering Context's
+ *  \ingroup intern */
 
-/** \defgroup memutil memutil
- *  \ingroup intern
- */
+/** \defgroup intern_iksolver Inverse Kinematics (Solver)
+ *  \ingroup intern */
 
-/** \defgroup mikktspace mikktspace
- *  \ingroup intern
- */
+/** \defgroup intern_itasc Inverse Kinematics (ITASC)
+ *  \ingroup intern */
 
-/** \defgroup moto moto
- *  \ingroup intern
- */
+/** \defgroup intern_libc_compat libc Compatibility For Linux
+ *  \ingroup intern */
 
-/** \defgroup eigen eigen
- *  \ingroup intern
- */
+/** \defgroup intern_locale Locale
+ *  \ingroup intern */
 
-/** \defgroup smoke smoke
- *  \ingroup intern
- */
+/** \defgroup intern_mantaflow Manta-Flow Fluid Simulation
+ *  \ingroup intern */
 
-/** \defgroup string string
- *  \ingroup intern
- */
+/** \defgroup intern_mem Guarded Memory (de)allocation
+ *  \ingroup intern */
+
+/** \defgroup intern_memutil Memory Utilities (memutil)
+ *  \ingroup intern */
+
+/** \defgroup intern_mikktspace MikktSpace
+ *  \ingroup intern */
+
+/** \defgroup intern_numaapi NUMA (Non Uniform Memory Architecture)
+ *  \ingroup intern */
+
+/** \defgroup intern_rigidbody Rigid-Body C-API
+ *  \ingroup intern */
+
+/** \defgroup intern_sky_model Sky Model
+ *  \ingroup intern */
+
+/** \defgroup intern_utf_conv UTF-8/16 Conversion (utfconv)
+ *  \ingroup intern */
 
 /** \defgroup audaspace Audaspace
  *  \ingroup intern undoc
- *  \todo add to doxygen
- */
+ *  \todo add to doxygen */
 /** \defgroup audcoreaudio Audaspace CoreAudio
- *  \ingroup audaspace
- */
+ *  \ingroup audaspace */
 /** \defgroup audfx Audaspace FX
- *  \ingroup audaspace
- */
+ *  \ingroup audaspace */
 /** \defgroup audopenal Audaspace OpenAL
- *  \ingroup audaspace
- */
+ *  \ingroup audaspace */
 /** \defgroup audpulseaudio Audaspace PulseAudio
- *  \ingroup audaspace
- */
+ *  \ingroup audaspace */
 /** \defgroup audwasapi Audaspace WASAPI
- *  \ingroup audaspace
- */
+ *  \ingroup audaspace */
 /** \defgroup audpython Audaspace Python
- *  \ingroup audaspace
- */
+ *  \ingroup audaspace */
 /** \defgroup audsdl Audaspace SDL
- *  \ingroup audaspace
- */
+ *  \ingroup audaspace */
 /** \defgroup audsrc Audaspace SRC
- *
- *  \ingroup audaspace
- */
+ *  \ingroup audaspace */
 /** \defgroup audffmpeg Audaspace FFMpeg
- *  \ingroup audaspace
- */
+ *  \ingroup audaspace */
 /** \defgroup audfftw Audaspace FFTW
- *  \ingroup audaspace
- */
+ *  \ingroup audaspace */
 /** \defgroup audjack Audaspace Jack
- *  \ingroup audaspace
- */
+ *  \ingroup audaspace */
 /** \defgroup audsndfile Audaspace sndfile
- *  \ingroup audaspace
- */
+ *  \ingroup audaspace */
 
 /** \defgroup GHOST GHOST API
  * \ingroup intern GUI
diff --git a/doc/doxygen/doxygen.source.h b/doc/doxygen/doxygen.source.h
index 510f3fe8ffe..4e351c9cc04 100644
--- a/doc/doxygen/doxygen.source.h
+++ b/doc/doxygen/doxygen.source.h
@@ -5,7 +5,8 @@
 /** \defgroup bmesh BMesh
  *  \ingroup blender
  */
-/** \defgroup compositor Compositing */
+/** \defgroup compositor Compositing
+ *  \ingroup blender */
 
 /** \defgroup python Python
  *  \ingroup blender
@@ -78,7 +79,8 @@
  *  \ingroup blender
  */
 
-/** \defgroup data DNA, RNA and .blend access*/
+/** \defgroup data DNA, RNA and .blend access
+ *  \ingroup blender */
 
 /** \defgroup gpu GPU
  *  \ingroup blender
@@ -101,11 +103,12 @@
  *   merged in docs.
  */
 
-/** \defgroup gui GUI */
+/**
+ * \defgroup gui GUI
+ * \ingroup blender */
 
 /** \defgroup wm Window Manager
- *  \ingroup blender gui
- */
+ *  \ingroup gui */
 
 /* ================================ */
 
@@ -279,7 +282,8 @@
  *  \ingroup gui
  */
 
-/** \defgroup externformats External Formats */
+/** \defgroup externformats External Formats
+ *  \ingroup blender */
 
 /** \defgroup collada COLLADA
  *  \ingroup externformats
@@ -308,4 +312,7 @@
 /* ================================ */
 
 /** \defgroup undoc Undocumented
- *  \brief Modules and libraries that are still undocumented, or lacking proper integration into the doxygen system, are marked in this group. */
+ *
+ * \brief Modules and libraries that are still undocumented,
+ * or lacking proper integration into the doxygen system, are marked in this group.
+ */
diff --git a/intern/atomic/atomic_ops.h b/intern/atomic/atomic_ops.h
index ad404c756ce..6a4d6d263c0 100644
--- a/intern/atomic/atomic_ops.h
+++ b/intern/atomic/atomic_ops.h
@@ -45,7 +45,7 @@
  */
 
 /** \file
- * \ingroup Atomic
+ * \ingroup intern_atomic
  *
  * \brief Provides wrapper around system-specific atomic primitives,
  * and some extensions (faked-atomic operations over float numbers).
diff --git a/intern/atomic/intern/atomic_ops_ext.h b/intern/atomic/intern/atomic_ops_ext.h
index 4dbc1153506..aedf0985169 100644
--- a/intern/atomic/intern/atomic_ops_ext.h
+++ b/intern/atomic/intern/atomic_ops_ext.h
@@ -44,6 +44,10 @@
  * The Original Code is: adapted from jemalloc.
  */
 
+/** \file
+ * \ingroup intern_atomic
+ */
+
 #ifndef __ATOMIC_OPS_EXT_H__
 #define __ATOMIC_OPS_EXT_H__
 
diff --git a/intern/atomic/intern/atomic_ops_msvc.h b/intern/atomic/intern/atomic_ops_msvc.h
index 9ed8f8e6295..ea5ae666db9 100644
--- a/intern/atomic/intern/atomic_ops_msvc.h
+++ b/intern/atomic/intern/atomic_ops_msvc.h
@@ -26,6 +26,10 @@
  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+/** \file
+ * \ingroup intern_atomic
+ */
+
 #ifndef __ATOMIC_OPS_MSVC_H__
 #define __ATOMIC_OPS_MSVC_H__
 
diff --git a/intern/atomic/intern/atomic_ops_unix.h b/intern/atomic/intern/atomic_ops_unix.h
index dcafbc67949..2fcfe34d03c 100644
--- a/intern/atomic/intern/atomic_ops_unix.h
+++ b/intern/atomic/intern/atomic_ops_unix.h
@@ -44,6 +44,10 @@
  * The Original Code is: adapted from jemalloc.
  */
 
+/** \file
+ * \ingroup intern_atomic
+ */
+
 #ifndef __ATOMIC_OPS_UNIX_H__
 #define __ATOMIC_OPS_UNIX_H__
 
diff --git a/intern/atomic/intern/atomic_ops_utils.h b/intern/atomic/intern/atomic_ops_utils.h
index 01f4284284a..533cfbe9e1f 100644
--- a/intern/atomic/intern/atomic_ops_utils.h
+++ b/intern/atomic/intern/atomic_ops_utils.h
@@ -44,6 +44,10 @@
  * The Original Code is: adapted from jemalloc.
  */
 
+/** \file
+ * \ingroup intern_atomic
+ */
+
 #ifndef __ATOMIC_OPS_UTILS_H__
 #define __ATOMIC_OPS_UTILS_H__
 
diff --git a/intern/clog/CLG_log.h b/intern/clog/CLG_log.h
index 8a26eb035cf..3664ade2981 100644
--- a/intern/clog/CLG_log.h
+++ b/intern/clog/CLG_log.h
@@ -14,11 +14,8 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
-#ifndef __CLG_LOG_H__
-#define __CLG_LOG_H__
-
 /** \file
- * \ingroup clog
+ * \ingroup intern_clog
  *
  * C Logging Library (clog)
  * ========================
@@ -68,6 +65,9 @@
  * - 4+: May be used for more details than 3, should be avoided but not prevented.
  */
 
+#ifndef __CLG_LOG_H__
+#define __CLG_LOG_H__
+
 #ifdef __cplusplus
 extern "C" {
 #endif /* __cplusplus */
diff --git a/intern/clog/clog.c b/intern/clog/clog.c
index 3501197511a..88cc0fbc4cb 100644
--- a/intern/clog/clog.c
+++ b/intern/clog/clog.c
@@ -15,7 +15,7 @@
  */
 
 /** \file
- * \ingroup clog
+ * \ingroup intern_clog
  */
 
 #include <assert.h>
diff --git a/intern/eigen/eigen_capi.h b/intern/eigen/eigen_capi.h
index 52ec489159f..4f8ecd03a42 100644
--- a/intern/eigen/eigen_capi.h
+++ b/intern/eigen/eigen_capi.h
@@ -17,6 +17,10 @@
  * All rights reserved.
  */
 
+/** \file
+ * \ingroup intern_eigen
+ */
+
 #ifndef __EIGEN_C_API_H__
 #define __EIGEN_C_API_H__
 
diff --git a/intern/eigen/intern/eigenvalues.h b/intern/eigen/intern/eigenvalues.h
index fabbdd87207..0f61d6ee3e8 100644
--- a/intern/eigen/intern/eigenvalues.h
+++ b/intern/eigen/intern/eigenvalues.h
@@ -17,6 +17,10 @@
  * All rights reserved.
  */
 
+/** \file
+ * \ingroup intern_eigen
+ */
+
 #ifndef __EIGEN3_EIGENVALUES_C_API_H__
 #define __EIGEN3_EIGENVALUES_C_API_H__
 
diff --git a/intern/eigen/intern/linear_solver.cc b/intern/eigen/intern/linear_solver.cc
index bce5937409c..4edc3426dca 100644
--- a/intern/eigen/intern/linear_solver.cc
+++ b/intern/eigen/intern/linear_solver.cc
@@ -22,6 +22,10 @@
  *  and the reason for such modification.
  */
 
+/** \file
+ * \ingroup intern_eigen
+ */
+
 #include "linear_solver.h"
 
 #include <Eigen/Sparse>
diff --git a/intern/eigen/intern/linear_solver.h b/intern/eigen/intern/linear_solver.h
index 4da1ec05cd0..6b9f815ca88 100644
--- a/intern/eigen/intern/linear_solver.h
+++ b/intern/eigen/intern/linear_solver.h
@@ -22,6 +22,10 @@
  *  and the reason for such modification.
  */
 
+/** \file
+ * \ingroup intern_eigen
+ */
+
 #pragma once
 
 #include <stdbool.h>
diff --git a/intern/eigen/intern/matrix.cc b/intern/eigen/intern/matrix.cc
index 2024a1ba59a..cff0e9cf264 100644
--- a/intern/eigen/intern/matrix.cc
+++ b/intern/eigen/intern/matrix.cc
@@ -17,6 +17,10 @@
  * All rights reserved.
  */
 
+/** \file
+ * \ingroup intern_eigen
+ */
+
 #ifndef __EIGEN3_MATRIX_C_API_CC__
 #define __EIGEN3_MATRIX_C_API_CC__
 
diff --git a/intern/eigen/intern/matrix.h b/intern/eigen/intern/matrix.h
index 91ef5e0713d..1f94e1cbe15 100644
--- a/intern/eigen/intern/matrix.h
+++ b/intern/eigen/intern/matrix.h
@@ -17,6 +17,10 @@
  * All rights reserved.
  */
 
+/** \file
+ * \ingroup intern_eigen
+ */
+
 #ifndef __EIGEN3_MATRIX_C_API_H__
 #define __EIGEN3_MATRIX_C_API_H__
 
diff --git a/intern/eigen/intern/svd.cc b/intern/eigen/intern/svd.

@@ Diff output truncated at 10240 characters. @@

More information about the Bf-blender-cvs mailing list