From 788a509184bdd47517b04da5be18bdbc30919e8f Mon Sep 17 00:00:00 2001 From: "luz.paz" Date: Sat, 19 Oct 2019 00:19:23 -0400 Subject: [PATCH] Doxygen: Base/Parameter.h description Adding a cursory description for `Parameter.h` + typo fix for it's companion .cpp file. . --- src/Base/Parameter.cpp | 2 +- src/Base/Parameter.h | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/src/Base/Parameter.cpp b/src/Base/Parameter.cpp index 788396607c..046e516d15 100644 --- a/src/Base/Parameter.cpp +++ b/src/Base/Parameter.cpp @@ -81,7 +81,7 @@ using namespace Base; //************************************************************************** //************************************************************************** -// privat classes declaration: +// private classes declaration: // - DOMTreeErrorReporter // - StrX // - DOMPrintFilter diff --git a/src/Base/Parameter.h b/src/Base/Parameter.h index 90c8c71830..7a7b7ee67a 100644 --- a/src/Base/Parameter.h +++ b/src/Base/Parameter.h @@ -22,6 +22,13 @@ * Juergen Riegel 2002 * ***************************************************************************/ + /** + * \file Parameter.h + * \brief The classes defined here are used to interface with the XML-based + * FreeCAD config files: user.cfg and system.cfg files. It can parse, get, + * and store the parameters/configurations for the user's preferences. + * 3rd party Xerces-C++ XML parser is used to parse and write the XML. + */ #ifndef BASE__PARAMETER_H #define BASE__PARAMETER_H