From 48c118c5e0fd05a9359bc729e1b675428ff615ab Mon Sep 17 00:00:00 2001 From: Yorik van Havre Date: Tue, 15 Nov 2016 16:17:58 -0200 Subject: [PATCH] Doc: small adjustments to doxygen docs --- src/Base/core-base.dox | 39 +++++++++++++---------------- src/Doc/CMakeLists.txt | 1 + src/Doc/primary-groups.dox | 2 +- src/Doc/templates/customdoxygen.css | 4 +-- src/Doc/templates/header.html | 6 +++-- 5 files changed, 25 insertions(+), 27 deletions(-) diff --git a/src/Base/core-base.dox b/src/Base/core-base.dox index 5407a5277052..a96de3e39f7d 100644 --- a/src/Base/core-base.dox +++ b/src/Base/core-base.dox @@ -1,28 +1,23 @@ -/** \defgroup BASE Base classes - * \ingroup CORE */ +/** \defgroup BASE Base + * \ingroup CORE + \brief Basic structures used by other FreeCAD components + + The Base module includes most of the basic functions of FreeCAD, such as: + - Console services: printing different kinds of messages to the FreeCAD report view or the terminal + - Python interpreter: handles the execution of Python code in FreeCAD + - Parameter handling: Management, saving and restoring of user preferences settings + - Units: Management and conversion of different units -/*! \namespace Base - \brief The namespace of the FreeCAD Base library - - This namespace includes most of the basic functions of FreeCAD like - - Console srvices - - Interpreter (Python binding) - - Parameter handling - - and so on...... */ -/** \defgroup BASE Base classes - * \ingroup CORE */ - /*! \namespace Base - \brief The namespace of the FreeCAD Base library - - This namespace includes most of the basic functions of FreeCAD like - - Console srvices - - Interpreter (Python binding) - - Parameter handling - - and so on...... + \ingroup BASE + \brief Basic structures used by other FreeCAD components + + The Base module includes most of the basic functions of FreeCAD, such as: + - Console services: printing different kinds of messages to the FreeCAD report view or the terminal + - Python interpreter: handles the execution of Python code in FreeCAD + - Parameter handling: Management, saving and restoring of user preferences settings + - Units: Management and conversion of different units */ diff --git a/src/Doc/CMakeLists.txt b/src/Doc/CMakeLists.txt index 59e9c572e43c..da6aea96b707 100644 --- a/src/Doc/CMakeLists.txt +++ b/src/Doc/CMakeLists.txt @@ -43,6 +43,7 @@ if(DOXYGEN_FOUND) set( DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Tools) list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/3rdParty/CxImage) list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/3rdParty/salomesmesh) + list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Assembly) STRING(REGEX REPLACE ";" " " DOXYGEN_EXCLUDE_LIST "${DOXYGEN_EXCLUDE_DIR}") diff --git a/src/Doc/primary-groups.dox b/src/Doc/primary-groups.dox index 0b79d5f65542..cfaa9f27896b 100644 --- a/src/Doc/primary-groups.dox +++ b/src/Doc/primary-groups.dox @@ -8,6 +8,6 @@ /** \defgroup WORKBENCHES Workbenches */ -/** \defgroup EMBEDDED Embedded 3rd party material +/** \defgroup EMBEDDED Embedded 3rd party libraries Important tools and libraries incorporated to FreeCAD. */ diff --git a/src/Doc/templates/customdoxygen.css b/src/Doc/templates/customdoxygen.css index a4fba579bd41..53a9a9eb9fef 100644 --- a/src/Doc/templates/customdoxygen.css +++ b/src/Doc/templates/customdoxygen.css @@ -336,9 +336,9 @@ span.SRScope { } -.memItemLeft, .memTemplItemLeft { +/*.memItemLeft, .memTemplItemLeft { white-space: normal; -} +} */ /* enumerations */ .panel-body thead > tr { diff --git a/src/Doc/templates/header.html b/src/Doc/templates/header.html index 791b21b19820..0846862b06cb 100644 --- a/src/Doc/templates/header.html +++ b/src/Doc/templates/header.html @@ -26,6 +26,7 @@ +