From 057c79c11c483b0b4c37acb14af059297417797a Mon Sep 17 00:00:00 2001 From: Yorik van Havre Date: Wed, 17 Jul 2019 18:01:56 -0300 Subject: [PATCH] Doxygen tweaks --- src/App/Document.cpp | 11 ++++++++++- src/App/DocumentObject.cpp | 4 ++++ src/App/Expression.cpp | 5 +++++ src/Base/Quantity.cpp | 5 +++++ src/Base/core-base.dox | 4 ++++ 5 files changed, 28 insertions(+), 1 deletion(-) diff --git a/src/App/Document.cpp b/src/App/Document.cpp index c4c31562ef..28f7dac679 100644 --- a/src/App/Document.cpp +++ b/src/App/Document.cpp @@ -21,7 +21,16 @@ ***************************************************************************/ -/*! \namespace App \class App::Document +/*! +\defgroup Document Document +\ingroup APP +\brief The Base class of the FreeCAD Document + +This is besides the Application class the most important class in FreeCAD +It contains all the data of the opened, saved or newly created FreeCAD Document. +The Document manage the Undo and Redo mechanism and the linking of documents. + +\namespace App \class App::Document This is besides the Application class the most important class in FreeCAD It contains all the data of the opened, saved or newly created FreeCAD Document. The Document manage the Undo and Redo mechanism and the linking of documents. diff --git a/src/App/DocumentObject.cpp b/src/App/DocumentObject.cpp index 55a1766f2d..902aab9611 100644 --- a/src/App/DocumentObject.cpp +++ b/src/App/DocumentObject.cpp @@ -42,6 +42,10 @@ using namespace App; +/** \defgroup DocObject Document Object + \ingroup APP + \brief Base class of all objects handled in the Document +*/ PROPERTY_SOURCE(App::DocumentObject, App::TransactionalObject) diff --git a/src/App/Expression.cpp b/src/App/Expression.cpp index cfddd7e643..a246bb1aa9 100644 --- a/src/App/Expression.cpp +++ b/src/App/Expression.cpp @@ -72,6 +72,11 @@ #pragma warning(disable : 4065) #endif +/** \defgroup Expression Expressions framework + \ingroup APP + \brief The expression system allows users to write expressions and formulas that produce values +*/ + using namespace Base; using namespace App; diff --git a/src/Base/Quantity.cpp b/src/Base/Quantity.cpp index 07298b345f..bd6ab6071d 100644 --- a/src/Base/Quantity.cpp +++ b/src/Base/Quantity.cpp @@ -34,6 +34,11 @@ #include "UnitsApi.h" #include "Console.h" +/** \defgroup Units Units system + \ingroup BASE + \brief The quantities and units system enables FreeCAD to work transparently with many different units +*/ + // suppress annoying warnings from generated source files #ifdef _MSC_VER # pragma warning(disable : 4003) diff --git a/src/Base/core-base.dox b/src/Base/core-base.dox index 27b7b73ff3..5726c8760f 100644 --- a/src/Base/core-base.dox +++ b/src/Base/core-base.dox @@ -21,3 +21,7 @@ - Units: Management and conversion of different units */ +/** \defgroup GeomPrimers Geometry primers + * \ingroup BASE + \brief Basic structures used by geomoetric objects +*/