From 2a99c26c955697c5bd3038cf4861d6e3f16f8cf9 Mon Sep 17 00:00:00 2001 From: Pieter Hijma Date: Sat, 22 Mar 2025 12:14:28 +0100 Subject: [PATCH 1/6] [Doc] Fix missing CXX directory --- src/Doc/CMakeLists.txt | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/Doc/CMakeLists.txt b/src/Doc/CMakeLists.txt index 4f41818662..d0f659e64f 100644 --- a/src/Doc/CMakeLists.txt +++ b/src/Doc/CMakeLists.txt @@ -31,22 +31,22 @@ if(DOXYGEN_FOUND) # directory order seems important for correct macro expansion # (files containing macros definitions must be parsed before the files using them) - SET(DOXYGEN_SOURCE_DIR ${COIN3D_INCLUDE_DIRS}/Inventor/fields/SoSubField.h - ${CMAKE_SOURCE_DIR}/src/CXX - ${CMAKE_SOURCE_DIR}/src/3rdParty/zipios++ + SET(DOXYGEN_SOURCE_DIR ${COIN3D_INCLUDE_DIRS}/Inventor/fields/SoSubField.h + ${CMAKE_SOURCE_DIR}/src/3rdParty/PyCXX/CXX + ${CMAKE_SOURCE_DIR}/src/3rdParty/zipios++ ${CMAKE_SOURCE_DIR}/src/3rdParty - ${CMAKE_SOURCE_DIR}/src/Build - ${CMAKE_SOURCE_DIR}/src/Base - ${CMAKE_BINARY_DIR}/src/Base - ${CMAKE_SOURCE_DIR}/src/App - ${CMAKE_BINARY_DIR}/src/App - ${CMAKE_SOURCE_DIR}/src/Gui - ${CMAKE_BINARY_DIR}/src/Gui + ${CMAKE_SOURCE_DIR}/src/Build + ${CMAKE_SOURCE_DIR}/src/Base + ${CMAKE_BINARY_DIR}/src/Base + ${CMAKE_SOURCE_DIR}/src/App + ${CMAKE_BINARY_DIR}/src/App + ${CMAKE_SOURCE_DIR}/src/Gui + ${CMAKE_BINARY_DIR}/src/Gui ${CMAKE_SOURCE_DIR}/src/Mod ${CMAKE_BINARY_DIR}/src/Mod - #${CMAKE_SOURCE_DIR}/src/Main #nothing to document there ATM... + ${CMAKE_SOURCE_DIR}/src/Main #nothing to document there ATM... ${CMAKE_SOURCE_DIR}/src/Doc - ${CMAKE_BINARY_DIR}/src/Doc + ${CMAKE_BINARY_DIR}/src/Doc ) STRING(REGEX REPLACE ";" " " DOXYGEN_INPUT_LIST "${DOXYGEN_SOURCE_DIR}") From d0c1f2c0735b75d979ada880f04bb6648d5d5164 Mon Sep 17 00:00:00 2001 From: Pieter Hijma Date: Mon, 24 Mar 2025 13:57:58 +0100 Subject: [PATCH 2/6] [Doc] Fix nested comment problem --- .../salomesmesh/src/StdMeshers/StdMeshers_Quadrangle_2D.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/3rdParty/salomesmesh/src/StdMeshers/StdMeshers_Quadrangle_2D.cpp b/src/3rdParty/salomesmesh/src/StdMeshers/StdMeshers_Quadrangle_2D.cpp index 5ebf9dbfb4..02173a2abe 100644 --- a/src/3rdParty/salomesmesh/src/StdMeshers/StdMeshers_Quadrangle_2D.cpp +++ b/src/3rdParty/salomesmesh/src/StdMeshers/StdMeshers_Quadrangle_2D.cpp @@ -4218,7 +4218,7 @@ bool StdMeshers_Quadrangle_2D::check() return isOK; } -/*//================================================================================ +//================================================================================ /*! * \brief Finds vertices at the most sharp face corners * \param [in] theFace - the FACE From d1ed87073eedaa268f51fd1d58951c5e715811da Mon Sep 17 00:00:00 2001 From: Pieter Hijma Date: Mon, 24 Mar 2025 14:44:54 +0100 Subject: [PATCH 3/6] [Doc] Fix nested groups in FEM --- src/Mod/Fem/feminout/convert2TetGen.py | 3 --- src/Mod/Fem/femsolver/fenics/fenics_tools.py | 3 --- src/Mod/Fem/femsolver/mystran/solver.py | 3 --- src/Mod/Fem/femsolver/z88/solver.py | 3 --- 4 files changed, 12 deletions(-) diff --git a/src/Mod/Fem/feminout/convert2TetGen.py b/src/Mod/Fem/feminout/convert2TetGen.py index ef7a001f1b..423770f2d1 100644 --- a/src/Mod/Fem/feminout/convert2TetGen.py +++ b/src/Mod/Fem/feminout/convert2TetGen.py @@ -40,9 +40,6 @@ if FreeCAD.GuiUp: Gui = FreeCADGui # shortcut -## \addtogroup FEM -# @{ - def exportMeshToTetGenPoly(meshToExport, filePath, beVerbose=1): """Export mesh to TetGen *.poly file format""" diff --git a/src/Mod/Fem/femsolver/fenics/fenics_tools.py b/src/Mod/Fem/femsolver/fenics/fenics_tools.py index 13b09e7488..0a34c6ce43 100644 --- a/src/Mod/Fem/femsolver/fenics/fenics_tools.py +++ b/src/Mod/Fem/femsolver/fenics/fenics_tools.py @@ -257,6 +257,3 @@ class FacetFunctionFromXDMF: # TODO: write some functions to return integrals for Neumann and Robin # boundary conditions for the general case (i.e. vector, tensor) - - -## @} diff --git a/src/Mod/Fem/femsolver/mystran/solver.py b/src/Mod/Fem/femsolver/mystran/solver.py index c7fa364e97..a6573a77b3 100644 --- a/src/Mod/Fem/femsolver/mystran/solver.py +++ b/src/Mod/Fem/femsolver/mystran/solver.py @@ -92,6 +92,3 @@ class ViewProxy(solverbase.ViewProxy): def getIcon(self): return ":/icons/FEM_SolverMystran.svg" - - -## @} diff --git a/src/Mod/Fem/femsolver/z88/solver.py b/src/Mod/Fem/femsolver/z88/solver.py index 0129b35ee6..61eb94b6be 100644 --- a/src/Mod/Fem/femsolver/z88/solver.py +++ b/src/Mod/Fem/femsolver/z88/solver.py @@ -111,6 +111,3 @@ class ViewProxy(solverbase.ViewProxy): def getIcon(self): return ":/icons/FEM_SolverZ88.svg" - - -## @} From b3ae844792a74ac45b2b9500f237727bd031f02b Mon Sep 17 00:00:00 2001 From: Pieter Hijma Date: Mon, 24 Mar 2025 14:46:31 +0100 Subject: [PATCH 4/6] [Doc] Fix CAM documentation problems - Fix nested comments - Fix section labels --- src/Mod/CAM/App/ParamsHelper.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/Mod/CAM/App/ParamsHelper.h b/src/Mod/CAM/App/ParamsHelper.h index 32ecb7237b..95f4d23243 100644 --- a/src/Mod/CAM/App/ParamsHelper.h +++ b/src/Mod/CAM/App/ParamsHelper.h @@ -27,7 +27,7 @@ * \ingroup PATH * Collections of macros for managing groups of parameters. * - * \section Motivation + * \section motivation_groups_params Motivation * * For an application like FreeCAD, there are often cases where the same set of * parameters are referred in dozons of different places. The macros here is @@ -61,7 +61,7 @@ * /src/Mod/CAM/App.CMakeFiles/Path.dir/Area.cpp.i * \endcode * - * \section Introduction of Boost.Preprocessor + * \section intro_boost_preproc Introduction of Boost.Preprocessor * * The macros here make heavy use of the awesome * [Boost.Preprocessor](http://www.boost.org/libs/preprocessor/) (short for @@ -1017,6 +1017,7 @@ * if(name1.isTouched()) return 1; * if(name2.isTouched()) return 1; * ... + * \endcode * \ingroup ParamProperty */ #define PARAM_PROP_TOUCHED(_seq) PARAM_FOREACH(PARAM_PROP_TOUCHED_, _seq) From 00428ff0141b58f0603d6258bf5fbb0617464671 Mon Sep 17 00:00:00 2001 From: Pieter Hijma Date: Mon, 24 Mar 2025 15:00:08 +0100 Subject: [PATCH 5/6] [Doc] Fix multiple use section label --- src/Gui/Language/Translator.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Gui/Language/Translator.cpp b/src/Gui/Language/Translator.cpp index 3955a2a887..aaac67479c 100644 --- a/src/Gui/Language/Translator.cpp +++ b/src/Gui/Language/Translator.cpp @@ -45,7 +45,7 @@ using namespace Gui; * The internationalization of FreeCAD makes heavy use of the internationalization * support of Qt. For more details refer to your Qt documentation. * - * \section stepbystep Step by step + * \section stepbystep_language Step by step * To integrate a new language into FreeCAD or one of its application modules * you have to perform the following steps: * From aa768e2a9002983b35906bfec8e3c809238d7d19 Mon Sep 17 00:00:00 2001 From: Pieter Hijma Date: Mon, 24 Mar 2025 15:42:26 +0100 Subject: [PATCH 6/6] [Doc] Fix Robot kdl documentation issues --- src/App/PropertyContainer.cpp | 2 +- src/Mod/Robot/App/kdl_cp/kdl.hpp | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/App/PropertyContainer.cpp b/src/App/PropertyContainer.cpp index 9efdd7a0fd..cbaac141f1 100644 --- a/src/App/PropertyContainer.cpp +++ b/src/App/PropertyContainer.cpp @@ -643,7 +643,7 @@ void PropertyData::visitProperties(OffsetBase offsetBase, /** \defgroup PropFrame Property framework \ingroup APP \brief System to access object properties -\section Introduction +\section propframe_intro Introduction The property framework introduces the ability to access attributes (member variables) of a class by name without knowing the class type. It's like the reflection mechanism of Java or C#. This ability is introduced by the App::PropertyContainer class and can be used by all derived classes. diff --git a/src/Mod/Robot/App/kdl_cp/kdl.hpp b/src/Mod/Robot/App/kdl_cp/kdl.hpp index b02e776aac..56bd5669e8 100644 --- a/src/Mod/Robot/App/kdl_cp/kdl.hpp +++ b/src/Mod/Robot/App/kdl_cp/kdl.hpp @@ -30,7 +30,7 @@ * href="http://www.orocos.org">Orocos, but that can be used * independently of Orocos. KDL offers different kinds of * functionality, grouped in the following Modules: - * - \subpage geomprim + * - \ref geomprim * - \ref KinematicFamily : functionality to build kinematic chains and access their kinematic and dynamic properties, such as e.g. Forward and Inverse kinematics and dynamics. * - \ref Motion : functionality to specify motion trajectories of frames and kinematic chains, such as e.g. Trapezoidal Velocity profiles. * @@ -38,7 +38,7 @@ **/ /** * \page geomprim Geometric Primitives - * \section Introduction + * \section kdl_geometric_prims Introduction * Geometric primitives are represented by the following classes. * - KDL::Vector * - KDL::Rotation