Doxygen: Base/Parameter.h description

Adding a cursory description for `Parameter.h` + typo fix for it's companion .cpp file. .
FreeCAD · Oct 19, 2019 · 788a509 · 788a509
1 parent 4614eb9
commit 788a509
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git 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
@@ -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