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.
This commit is contained in:
Campbell Barton 2021-12-14 18:35:31 +11:00
parent a207c1cdaf
commit f6fd3a84c2
117 changed files with 296 additions and 154 deletions

View File

@ -6,91 +6,90 @@
* as part of the normal development process. * as part of the normal development process.
*/ */
/** \defgroup MEM Guarded memory (de)allocation /* TODO: other modules.
* \ingroup intern * - `libmv`
* - `cycles`
* - `opencolorio`
* - `opensubdiv`
* - `openvdb`
* - `quadriflow`
*/ */
/** \defgroup clog C-Logging (CLOG) /** \defgroup intern_atomic Atomic Operations
* \ingroup intern * \ingroup intern */
*/
/** \defgroup ctr container /** \defgroup intern_clog C-Logging (CLOG)
* \ingroup intern * \ingroup intern */
*/
/** \defgroup iksolver iksolver /** \defgroup intern_eigen Eigen
* \ingroup intern * \ingroup intern */
*/
/** \defgroup itasc itasc /** \defgroup intern_glew-mx GLEW with Multiple Rendering Context's
* \ingroup intern * \ingroup intern */
*/
/** \defgroup memutil memutil /** \defgroup intern_iksolver Inverse Kinematics (Solver)
* \ingroup intern * \ingroup intern */
*/
/** \defgroup mikktspace mikktspace /** \defgroup intern_itasc Inverse Kinematics (ITASC)
* \ingroup intern * \ingroup intern */
*/
/** \defgroup moto moto /** \defgroup intern_libc_compat libc Compatibility For Linux
* \ingroup intern * \ingroup intern */
*/
/** \defgroup eigen eigen /** \defgroup intern_locale Locale
* \ingroup intern * \ingroup intern */
*/
/** \defgroup smoke smoke /** \defgroup intern_mantaflow Manta-Flow Fluid Simulation
* \ingroup intern * \ingroup intern */
*/
/** \defgroup string string /** \defgroup intern_mem Guarded Memory (de)allocation
* \ingroup intern * \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 /** \defgroup audaspace Audaspace
* \ingroup intern undoc * \ingroup intern undoc
* \todo add to doxygen * \todo add to doxygen */
*/
/** \defgroup audcoreaudio Audaspace CoreAudio /** \defgroup audcoreaudio Audaspace CoreAudio
* \ingroup audaspace * \ingroup audaspace */
*/
/** \defgroup audfx Audaspace FX /** \defgroup audfx Audaspace FX
* \ingroup audaspace * \ingroup audaspace */
*/
/** \defgroup audopenal Audaspace OpenAL /** \defgroup audopenal Audaspace OpenAL
* \ingroup audaspace * \ingroup audaspace */
*/
/** \defgroup audpulseaudio Audaspace PulseAudio /** \defgroup audpulseaudio Audaspace PulseAudio
* \ingroup audaspace * \ingroup audaspace */
*/
/** \defgroup audwasapi Audaspace WASAPI /** \defgroup audwasapi Audaspace WASAPI
* \ingroup audaspace * \ingroup audaspace */
*/
/** \defgroup audpython Audaspace Python /** \defgroup audpython Audaspace Python
* \ingroup audaspace * \ingroup audaspace */
*/
/** \defgroup audsdl Audaspace SDL /** \defgroup audsdl Audaspace SDL
* \ingroup audaspace * \ingroup audaspace */
*/
/** \defgroup audsrc Audaspace SRC /** \defgroup audsrc Audaspace SRC
* * \ingroup audaspace */
* \ingroup audaspace
*/
/** \defgroup audffmpeg Audaspace FFMpeg /** \defgroup audffmpeg Audaspace FFMpeg
* \ingroup audaspace * \ingroup audaspace */
*/
/** \defgroup audfftw Audaspace FFTW /** \defgroup audfftw Audaspace FFTW
* \ingroup audaspace * \ingroup audaspace */
*/
/** \defgroup audjack Audaspace Jack /** \defgroup audjack Audaspace Jack
* \ingroup audaspace * \ingroup audaspace */
*/
/** \defgroup audsndfile Audaspace sndfile /** \defgroup audsndfile Audaspace sndfile
* \ingroup audaspace * \ingroup audaspace */
*/
/** \defgroup GHOST GHOST API /** \defgroup GHOST GHOST API
* \ingroup intern GUI * \ingroup intern GUI

View File

@ -5,7 +5,8 @@
/** \defgroup bmesh BMesh /** \defgroup bmesh BMesh
* \ingroup blender * \ingroup blender
*/ */
/** \defgroup compositor Compositing */ /** \defgroup compositor Compositing
* \ingroup blender */
/** \defgroup python Python /** \defgroup python Python
* \ingroup blender * \ingroup blender
@ -78,7 +79,8 @@
* \ingroup blender * \ingroup blender
*/ */
/** \defgroup data DNA, RNA and .blend access*/ /** \defgroup data DNA, RNA and .blend access
* \ingroup blender */
/** \defgroup gpu GPU /** \defgroup gpu GPU
* \ingroup blender * \ingroup blender
@ -101,11 +103,12 @@
* merged in docs. * merged in docs.
*/ */
/** \defgroup gui GUI */ /**
* \defgroup gui GUI
* \ingroup blender */
/** \defgroup wm Window Manager /** \defgroup wm Window Manager
* \ingroup blender gui * \ingroup gui */
*/
/* ================================ */ /* ================================ */
@ -279,7 +282,8 @@
* \ingroup gui * \ingroup gui
*/ */
/** \defgroup externformats External Formats */ /** \defgroup externformats External Formats
* \ingroup blender */
/** \defgroup collada COLLADA /** \defgroup collada COLLADA
* \ingroup externformats * \ingroup externformats
@ -308,4 +312,7 @@
/* ================================ */ /* ================================ */
/** \defgroup undoc Undocumented /** \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.
*/

View File

@ -45,7 +45,7 @@
*/ */
/** \file /** \file
* \ingroup Atomic * \ingroup intern_atomic
* *
* \brief Provides wrapper around system-specific atomic primitives, * \brief Provides wrapper around system-specific atomic primitives,
* and some extensions (faked-atomic operations over float numbers). * and some extensions (faked-atomic operations over float numbers).

View File

@ -44,6 +44,10 @@
* The Original Code is: adapted from jemalloc. * The Original Code is: adapted from jemalloc.
*/ */
/** \file
* \ingroup intern_atomic
*/
#ifndef __ATOMIC_OPS_EXT_H__ #ifndef __ATOMIC_OPS_EXT_H__
#define __ATOMIC_OPS_EXT_H__ #define __ATOMIC_OPS_EXT_H__

View File

@ -26,6 +26,10 @@
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/** \file
* \ingroup intern_atomic
*/
#ifndef __ATOMIC_OPS_MSVC_H__ #ifndef __ATOMIC_OPS_MSVC_H__
#define __ATOMIC_OPS_MSVC_H__ #define __ATOMIC_OPS_MSVC_H__

View File

@ -44,6 +44,10 @@
* The Original Code is: adapted from jemalloc. * The Original Code is: adapted from jemalloc.
*/ */
/** \file
* \ingroup intern_atomic
*/
#ifndef __ATOMIC_OPS_UNIX_H__ #ifndef __ATOMIC_OPS_UNIX_H__
#define __ATOMIC_OPS_UNIX_H__ #define __ATOMIC_OPS_UNIX_H__

View File

@ -44,6 +44,10 @@
* The Original Code is: adapted from jemalloc. * The Original Code is: adapted from jemalloc.
*/ */
/** \file
* \ingroup intern_atomic
*/
#ifndef __ATOMIC_OPS_UTILS_H__ #ifndef __ATOMIC_OPS_UTILS_H__
#define __ATOMIC_OPS_UTILS_H__ #define __ATOMIC_OPS_UTILS_H__

View File

@ -14,11 +14,8 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/ */
#ifndef __CLG_LOG_H__
#define __CLG_LOG_H__
/** \file /** \file
* \ingroup clog * \ingroup intern_clog
* *
* C Logging Library (clog) * C Logging Library (clog)
* ======================== * ========================
@ -68,6 +65,9 @@
* - 4+: May be used for more details than 3, should be avoided but not prevented. * - 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 #ifdef __cplusplus
extern "C" { extern "C" {
#endif /* __cplusplus */ #endif /* __cplusplus */

View File

@ -15,7 +15,7 @@
*/ */
/** \file /** \file
* \ingroup clog * \ingroup intern_clog
*/ */
#include <assert.h> #include <assert.h>

View File

@ -17,6 +17,10 @@
* All rights reserved. * All rights reserved.
*/ */
/** \file
* \ingroup intern_eigen
*/
#ifndef __EIGEN_C_API_H__ #ifndef __EIGEN_C_API_H__
#define __EIGEN_C_API_H__ #define __EIGEN_C_API_H__

View File

@ -17,6 +17,10 @@
* All rights reserved. * All rights reserved.
*/ */
/** \file
* \ingroup intern_eigen
*/
#ifndef __EIGEN3_EIGENVALUES_C_API_H__ #ifndef __EIGEN3_EIGENVALUES_C_API_H__
#define __EIGEN3_EIGENVALUES_C_API_H__ #define __EIGEN3_EIGENVALUES_C_API_H__

View File

@ -22,6 +22,10 @@
* and the reason for such modification. * and the reason for such modification.
*/ */
/** \file
* \ingroup intern_eigen
*/
#include "linear_solver.h" #include "linear_solver.h"
#include <Eigen/Sparse> #include <Eigen/Sparse>

View File

@ -22,6 +22,10 @@
* and the reason for such modification. * and the reason for such modification.
*/ */
/** \file
* \ingroup intern_eigen
*/
#pragma once #pragma once
#include <stdbool.h> #include <stdbool.h>

View File

@ -17,6 +17,10 @@
* All rights reserved. * All rights reserved.
*/ */
/** \file
* \ingroup intern_eigen
*/
#ifndef __EIGEN3_MATRIX_C_API_CC__ #ifndef __EIGEN3_MATRIX_C_API_CC__
#define __EIGEN3_MATRIX_C_API_CC__ #define __EIGEN3_MATRIX_C_API_CC__

View File

@ -17,6 +17,10 @@
* All rights reserved. * All rights reserved.
*/ */
/** \file
* \ingroup intern_eigen
*/
#ifndef __EIGEN3_MATRIX_C_API_H__ #ifndef __EIGEN3_MATRIX_C_API_H__
#define __EIGEN3_MATRIX_C_API_H__ #define __EIGEN3_MATRIX_C_API_H__

View File

@ -17,6 +17,10 @@
* All rights reserved. * All rights reserved.
*/ */
/** \file
* \ingroup intern_eigen
*/
#ifndef __EIGEN3_SVD_C_API_CC__ #ifndef __EIGEN3_SVD_C_API_CC__
#define __EIGEN3_SVD_C_API_CC__ #define __EIGEN3_SVD_C_API_CC__

View File

@ -17,6 +17,10 @@
* All rights reserved. * All rights reserved.
*/ */
/** \file
* \ingroup intern_eigen
*/
#ifndef __EIGEN3_SVD_C_API_H__ #ifndef __EIGEN3_SVD_C_API_H__
#define __EIGEN3_SVD_C_API_H__ #define __EIGEN3_SVD_C_API_H__

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup glew-mx * \ingroup intern_glew-mx
* *
* Support for GLEW Multiple rendering conteXts (MX) * Support for GLEW Multiple rendering conteXts (MX)
* Maintained as a Blender Library. * Maintained as a Blender Library.

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup glew-mx * \ingroup intern_glew-mx
* Utility used to check for use of deprecated functions. * Utility used to check for use of deprecated functions.
*/ */

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup glew-mx * \ingroup intern_glew-mx
*/ */
#include "glew-mx.h" #include "glew-mx.h"

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup glew-mx * \ingroup intern_glew-mx
* *
* This file is for any simple stuff that is missing from GLEW when * This file is for any simple stuff that is missing from GLEW when
* compiled with either the GLEW_ES_ONLY or the GLEW_NO_ES flag. * compiled with either the GLEW_ES_ONLY or the GLEW_NO_ES flag.

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup MEM * \ingroup intern_mem
* *
* \brief Read \ref MEMPage * \brief Read \ref MEMPage
* *

View File

@ -15,7 +15,7 @@
*/ */
/** \file /** \file
* \ingroup MEM * \ingroup intern_mem
*/ */
#include "../MEM_guardedalloc.h" #include "../MEM_guardedalloc.h"

View File

@ -15,7 +15,7 @@
*/ */
/** \file /** \file
* \ingroup MEM * \ingroup intern_mem
*/ */
#include <cstdio> /* Needed for `printf` on WIN32/APPLE. */ #include <cstdio> /* Needed for `printf` on WIN32/APPLE. */

View File

@ -15,7 +15,7 @@
*/ */
/** \file /** \file
* \ingroup MEM * \ingroup intern_mem
* *
* Guarded memory allocation, and boundary-write detection. * Guarded memory allocation, and boundary-write detection.
*/ */

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup MEM * \ingroup intern_mem
* *
* Guarded memory allocation, and boundary-write detection. * Guarded memory allocation, and boundary-write detection.
*/ */

View File

@ -27,7 +27,7 @@
*/ */
/** \file /** \file
* \ingroup MEM * \ingroup intern_mem
*/ */
#ifndef __MALLOCN_INLINE_H__ #ifndef __MALLOCN_INLINE_H__

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup MEM * \ingroup intern_mem
*/ */
#ifndef __MALLOCN_INTERN_H__ #ifndef __MALLOCN_INTERN_H__

View File

@ -15,7 +15,7 @@
*/ */
/** \file /** \file
* \ingroup MEM * \ingroup intern_mem
* *
* Memory allocation which keeps track on allocated memory counters * Memory allocation which keeps track on allocated memory counters
*/ */

View File

@ -19,7 +19,7 @@
*/ */
/** \file /** \file
* \ingroup iksolver * \ingroup intern_iksolver
*/ */
/** /**

View File

@ -18,6 +18,10 @@
* Original author: Laurence * Original author: Laurence
*/ */
/** \file
* \ingroup intern_iksolver
*/
#pragma once #pragma once
#include <Eigen/Core> #include <Eigen/Core>

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup iksolver * \ingroup intern_iksolver
*/ */
#include "IK_QJacobian.h" #include "IK_QJacobian.h"

View File

@ -19,7 +19,7 @@
*/ */
/** \file /** \file
* \ingroup iksolver * \ingroup intern_iksolver
*/ */
#pragma once #pragma once

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup iksolver * \ingroup intern_iksolver
*/ */
#include <stdio.h> #include <stdio.h>

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup iksolver * \ingroup intern_iksolver
*/ */
#pragma once #pragma once

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup iksolver * \ingroup intern_iksolver
*/ */
#include "IK_QSegment.h" #include "IK_QSegment.h"

View File

@ -19,7 +19,7 @@
*/ */
/** \file /** \file
* \ingroup iksolver * \ingroup intern_iksolver
*/ */
#pragma once #pragma once

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup iksolver * \ingroup intern_iksolver
*/ */
#include "IK_QTask.h" #include "IK_QTask.h"

View File

@ -19,7 +19,7 @@
*/ */
/** \file /** \file
* \ingroup iksolver * \ingroup intern_iksolver
*/ */
#pragma once #pragma once

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup iksolver * \ingroup intern_iksolver
*/ */
#include "../extern/IK_solver.h" #include "../extern/IK_solver.h"

View File

@ -1,5 +1,5 @@
/** \file itasc/Armature.cpp /** \file itasc/Armature.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* Armature.cpp * Armature.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/Cache.cpp /** \file itasc/Cache.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* Cache.cpp * Cache.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/ConstraintSet.cpp /** \file itasc/ConstraintSet.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* ConstraintSet.cpp * ConstraintSet.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/ControlledObject.cpp /** \file itasc/ControlledObject.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* ControlledObject.cpp * ControlledObject.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/CopyPose.cpp /** \file itasc/CopyPose.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* CopyPose.cpp * CopyPose.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/Distance.cpp /** \file itasc/Distance.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* Distance.cpp * Distance.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/FixedObject.cpp /** \file itasc/FixedObject.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* FixedObject.cpp * FixedObject.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/MovingFrame.cpp /** \file itasc/MovingFrame.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* MovingFrame.cpp * MovingFrame.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/Scene.cpp /** \file itasc/Scene.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* Scene.cpp * Scene.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/UncontrolledObject.cpp /** \file itasc/UncontrolledObject.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* UncontrolledObject.cpp * UncontrolledObject.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/WDLSSolver.cpp /** \file itasc/WDLSSolver.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* WDLSSolver.hpp.cpp * WDLSSolver.hpp.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/WSDLSSolver.cpp /** \file itasc/WSDLSSolver.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* WDLSSolver.hpp.cpp * WDLSSolver.hpp.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/WorldObject.cpp /** \file itasc/WorldObject.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* WorldObject.cpp * WorldObject.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/eigen_types.cpp /** \file itasc/eigen_types.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* eigen_types.cpp * eigen_types.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/chain.cpp /** \file itasc/kdl/chain.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be>

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/chainfksolverpos_recursive.cpp /** \file itasc/kdl/chainfksolverpos_recursive.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Copyright (C) 2007 Francois Cauwe <francois at cauwe dot org> // Copyright (C) 2007 Francois Cauwe <francois at cauwe dot org>
// Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be>

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/chainjnttojacsolver.cpp /** \file itasc/kdl/chainjnttojacsolver.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be>

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/frameacc.cpp /** \file itasc/kdl/frameacc.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/***************************************************************************** /*****************************************************************************
* Erwin Aertbelien, Div. PMA, Dep. of Mech. Eng., K.U.Leuven * Erwin Aertbelien, Div. PMA, Dep. of Mech. Eng., K.U.Leuven

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/frames.cpp /** \file itasc/kdl/frames.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/*************************************************************************** /***************************************************************************
frames.cxx - description frames.cxx - description

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/frames_io.cpp /** \file itasc/kdl/frames_io.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/*************************************************************************** /***************************************************************************

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/framevel.cpp /** \file itasc/kdl/framevel.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/***************************************************************************** /*****************************************************************************
* Erwin Aertbelien, Div. PMA, Dep. of Mech. Eng., K.U.Leuven * Erwin Aertbelien, Div. PMA, Dep. of Mech. Eng., K.U.Leuven

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/inertia.cpp /** \file itasc/kdl/inertia.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be>

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/jacobian.cpp /** \file itasc/kdl/jacobian.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be>

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/jntarray.cpp /** \file itasc/kdl/jntarray.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be>

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/jntarrayacc.cpp /** \file itasc/kdl/jntarrayacc.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be>

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/jntarrayvel.cpp /** \file itasc/kdl/jntarrayvel.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be>

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/joint.cpp /** \file itasc/kdl/joint.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be>

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/kinfam_io.cpp /** \file itasc/kdl/kinfam_io.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be>

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/segment.cpp /** \file itasc/kdl/segment.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Version: 1.0 // Version: 1.0
// Author: Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Author: Ruben Smits <ruben dot smits at mech dot kuleuven dot be>

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/tree.cpp /** \file itasc/kdl/tree.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be>

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/treefksolverpos_recursive.cpp /** \file itasc/kdl/treefksolverpos_recursive.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
// Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> // Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be>
// Copyright (C) 2008 Julia Jesse // Copyright (C) 2008 Julia Jesse

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/treejnttojacsolver.cpp /** \file itasc/kdl/treejnttojacsolver.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* /*
* TreeJntToJacSolver.cpp * TreeJntToJacSolver.cpp

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/utilities/error_stack.cpp /** \file itasc/kdl/utilities/error_stack.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/***************************************************************************** /*****************************************************************************
* Erwin Aertbelien, Div. PMA, Dep. of Mech. Eng., K.U.Leuven * Erwin Aertbelien, Div. PMA, Dep. of Mech. Eng., K.U.Leuven

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/utilities/kdl-config.h /** \file itasc/kdl/utilities/kdl-config.h
* \ingroup itasc * \ingroup intern_itasc
*/ */
/* Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> */ /* Copyright (C) 2007 Ruben Smits <ruben dot smits at mech dot kuleuven dot be> */

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/utilities/traits.h /** \file itasc/kdl/utilities/traits.h
* \ingroup itasc * \ingroup intern_itasc
*/ */
#ifndef KDLPV_TRAITS_H #ifndef KDLPV_TRAITS_H
#define KDLPV_TRAITS_H #define KDLPV_TRAITS_H

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/utilities/utility.cpp /** \file itasc/kdl/utilities/utility.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/** @file utility.cpp /** @file utility.cpp
* @author Erwin Aertbelien, Div. PMA, Dep. of Mech. Eng., K.U.Leuven * @author Erwin Aertbelien, Div. PMA, Dep. of Mech. Eng., K.U.Leuven

View File

@ -1,5 +1,5 @@
/** \file itasc/kdl/utilities/utility_io.cpp /** \file itasc/kdl/utilities/utility_io.cpp
* \ingroup itasc * \ingroup intern_itasc
*/ */
/***************************************************************************** /*****************************************************************************
* Erwin Aertbelien, Div. PMA, Dep. of Mech. Eng., K.U.Leuven * Erwin Aertbelien, Div. PMA, Dep. of Mech. Eng., K.U.Leuven

View File

@ -21,6 +21,10 @@
* incompatible with the system libraries that Blender is built on. To solve * incompatible with the system libraries that Blender is built on. To solve
* this we add a few -ffast-math symbols that can be missing. */ * this we add a few -ffast-math symbols that can be missing. */
/** \file
* \ingroup intern_libc_compat
*/
#ifdef __linux__ #ifdef __linux__
# include <features.h> # include <features.h>
# include <math.h> # include <math.h>

View File

@ -17,6 +17,10 @@
* All rights reserved. * All rights reserved.
*/ */
/** \file
* \ingroup intern_locale
*/
#include <boost/locale.hpp> #include <boost/locale.hpp>
#include <stdio.h> #include <stdio.h>

View File

@ -18,8 +18,8 @@
*/ */
/** \file /** \file
* \ingroup locale * \ingroup intern_locale
* A thin C wrapper around boost::locale... * A thin C wrapper around `boost::locale`.
*/ */
#ifndef __BOOST_LOCALE_WRAPPER_H__ #ifndef __BOOST_LOCALE_WRAPPER_H__

View File

@ -1,5 +1,9 @@
#include "boost_locale_wrapper.h" #include "boost_locale_wrapper.h"
/** \file
* \ingroup intern_locale
*/
#import <Cocoa/Cocoa.h> #import <Cocoa/Cocoa.h>
#include <cstdlib> #include <cstdlib>

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup mantaflow * \ingroup intern_mantaflow
*/ */
#ifndef MANTA_API_H #ifndef MANTA_API_H

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup mantaflow * \ingroup intern_mantaflow
*/ */
#ifndef MANTA_PYTHON_API_H #ifndef MANTA_PYTHON_API_H

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup mantaflow * \ingroup intern_mantaflow
*/ */
#include <fstream> #include <fstream>

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup mantaflow * \ingroup intern_mantaflow
*/ */
#ifndef MANTA_A_H #ifndef MANTA_A_H

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup mantaflow * \ingroup intern_mantaflow
*/ */
#include <cmath> #include <cmath>

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup mantaflow * \ingroup intern_mantaflow
*/ */
#include "manta_python_API.h" #include "manta_python_API.h"

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup mantaflow * \ingroup intern_mantaflow
*/ */
#include <string> #include <string>

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup mantaflow * \ingroup intern_mantaflow
*/ */
#include <string> #include <string>

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup mantaflow * \ingroup intern_mantaflow
*/ */
#include <string> #include <string>

View File

@ -15,7 +15,7 @@
*/ */
/** \file /** \file
* \ingroup memutil * \ingroup intern_memutil
*/ */
#ifndef __MEM_ALLOCATOR_H__ #ifndef __MEM_ALLOCATOR_H__

View File

@ -15,7 +15,7 @@
*/ */
/** \file /** \file
* \ingroup memutil * \ingroup intern_memutil
*/ */
#ifndef __MEM_CACHELIMITER_H__ #ifndef __MEM_CACHELIMITER_H__

View File

@ -15,7 +15,7 @@
*/ */
/** \file /** \file
* \ingroup memutil * \ingroup intern_memutil
*/ */
#ifndef __MEM_CACHELIMITERC_API_H__ #ifndef __MEM_CACHELIMITERC_API_H__

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup memutil * \ingroup intern_memutil
* *
* Declaration of MEM_RefCounted class. * Declaration of MEM_RefCounted class.
*/ */

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup memutil * \ingroup intern_memutil
* *
* Interface for C access to functionality relating to shared objects in the foundation library. * Interface for C access to functionality relating to shared objects in the foundation library.
*/ */

View File

@ -15,7 +15,7 @@
*/ */
/** \file /** \file
* \ingroup memutil * \ingroup intern_memutil
*/ */
#include <cstddef> #include <cstddef>

View File

@ -18,7 +18,7 @@
*/ */
/** \file /** \file
* \ingroup memutil * \ingroup intern_memutil
*/ */
#include "MEM_RefCountedC-Api.h" #include "MEM_RefCountedC-Api.h"

View File

@ -20,6 +20,10 @@
// //
// Author: Sergey Sharybin <sergey.vfx@gmail.com> // Author: Sergey Sharybin <sergey.vfx@gmail.com>
/** \file
* \ingroup intern_numaapi
*/
#ifndef __LIBNUMAAPI_H__ #ifndef __LIBNUMAAPI_H__
#define __LIBNUMAAPI_H__ #define __LIBNUMAAPI_H__

View File

@ -20,6 +20,10 @@
// //
// Author: Sergey Sharybin <sergey.vfx@gmail.com> // Author: Sergey Sharybin <sergey.vfx@gmail.com>
/** \file
* \ingroup intern_numaapi
*/
#ifndef __BUILD_CONFIG_H__ #ifndef __BUILD_CONFIG_H__
#define __BUILD_CONFIG_H__ #define __BUILD_CONFIG_H__

View File

@ -20,6 +20,10 @@
// //
// Author: Sergey Sharybin <sergey.vfx@gmail.com> // Author: Sergey Sharybin <sergey.vfx@gmail.com>
/** \file
* \ingroup intern_numaapi
*/
#include "numaapi.h" #include "numaapi.h"
#include <assert.h> #include <assert.h>

Some files were not shown because too many files have changed in this diff Show More