dayly work

diff --git a/rplcore/rplconfig.cpp b/rplcore/rplconfig.cpp
index 44d2d758e78df88fb65927a90ed358f8867e7e94..ba965715eba787a1d4ba286614dbb49def360ef4 100644 (file)
--- a/rplcore/rplconfig.cpp
+++ b/rplcore/rplconfig.cpp
@@ -7,6 +7,15 @@
  */
 #include "rplcore/rplcore.hpp"
 
+/** @file
+ *
+ * @brief Reading/writing configuration files.
+ */
+/** @file rplcore/rplconfig.hpp
+ *
+ * @brief Definitions for reading/writing configuration files.
+ */
+
 /** @class RplConfig rplconfig.hpp "rplcore/rplconfig.hpp"
  *
  * @brief Imports and exports a configuration file into a QHash instance.

diff --git a/rplcore/rplcontainer.cpp b/rplcore/rplcontainer.cpp
index 5760dda36786f377225f619ed580426741ee8b70..2dbd97680ca27f082a7085da834d35d0c5ea6ef2 100644 (file)
--- a/rplcore/rplcontainer.cpp
+++ b/rplcore/rplcontainer.cpp
@@ -11,6 +11,11 @@
  * @brief Implements a portable data container.
  */
 
+/** @file rplcore/rplcontainer.hpp
+ *
+ * @brief Definition for a portable data container.
+ */
+
 /** @class RplContainer rplcontainer.hpp "rplcore/rplcontainer.hpp"
  *
  * @brief Implements a portable data container.

diff --git a/rplcore/rplexception.cpp b/rplcore/rplexception.cpp
index 16ffc29f2cd3c50a2227444c641a40e90ce96b2c..dcc77f44141b4f77ef6b0ffd43fcd0676452ba33 100644 (file)
--- a/rplcore/rplexception.cpp
+++ b/rplcore/rplexception.cpp
@@ -30,6 +30,10 @@
 /** @file
  * @brief Generally usable exceptions.
  */
+/** @file rplcore/rplexeption.hpp
+ *
+ * @brief Definitions for a generally usable exceptions.
+ */
 #include "rplcore/rplcore.hpp"
 
 /** @class RplException rplexception.hpp "rplcore/rplexception.hpp"

diff --git a/rplcore/rpllogger.cpp b/rplcore/rpllogger.cpp
index f85bcae604384fc283b822ca30af13012d9fe249..b998d68fe6838f8d48e071a0938a87f168aa8108 100644 (file)
--- a/rplcore/rpllogger.cpp
+++ b/rplcore/rpllogger.cpp
@@ -9,6 +9,10 @@
 /** @file
  * A configurable logger for different output media.
  */
+/** @file rplcore/rpllogger.hpp
+ *
+ * Definitions for a configurable logger for different output media.
+ */
 #include "rplcore/rplcore.hpp"
 #include <QDir>
 #include <iostream>

diff --git a/rplcore/rplqstring.cpp b/rplcore/rplqstring.cpp
index 664a1862479f66167c642be706e1f4cd99480326..b0d64af3d4c552cfcf825fb60395b400e9c9fb39 100644 (file)
--- a/rplcore/rplqstring.cpp
+++ b/rplcore/rplqstring.cpp
@@ -9,6 +9,10 @@
 /** @file
  * @brief Missed operation for <code>QString</code>s.
  */
+/** @file rplcore/rplqstring.hpp
+ *
+ * @brief Definitions for missed operation for <code>QString</code>s.
+ */
 #include "rplcore/rplcore.hpp"
 
 

diff --git a/rplcore/rplstring.cpp b/rplcore/rplstring.cpp
index d98d746a2695543d4921f274d2f187e573d31895..a9c4b83cb879c0c7050043d3fcf353f9a7d8c01a 100644 (file)
--- a/rplcore/rplstring.cpp
+++ b/rplcore/rplstring.cpp
@@ -6,7 +6,11 @@
  * The original sources can be found on https://github.com/republib.
  */
 /** @file
- * @brief Missed operation for <code>QByteArray</code>s.
+ * @brief Missed operations for <code>QByteArray</code>s.
+ */
+/** @file rplcore/rplstring.cpp
+ *
+ * @brief Definitions for missed operations for <code>QByteArray</code>s.
  */
 #include "rplcore.hpp"
 

diff --git a/rplcore/rplterminator.cpp b/rplcore/rplterminator.cpp
index 9270bef4aec71d5e3fcbb63f9ab9dc99324c0dbf..a223ddd4262ae52c75bcfcf2cdb37356d3a974cb 100644 (file)
--- a/rplcore/rplterminator.cpp
+++ b/rplcore/rplterminator.cpp
@@ -8,6 +8,9 @@
 /** @file
  * @brief Implements a thread stopper.
  */
+/** @file
+ * @brief Definitions for a thread stopper.
+ */
 #include "rplcore.hpp"
 
 enum {

diff --git a/rplcore/rpltest.cpp b/rplcore/rpltest.cpp
index 340611bb805f3b74d8ee62fe87bc85a32a85140c..3fd6a3e566c7632781e74f19a0f775e60ebd2fcd 100644 (file)
--- a/rplcore/rpltest.cpp
+++ b/rplcore/rpltest.cpp
@@ -8,6 +8,10 @@
 /** @file
  * @brief A testing tool like JUnit.
  */
+/** @file rplcore/rpltest.hpp
+ *
+ * @brief Definitions for a testing tool like JUnit.
+ */
 #include "rplcore/rplcore.hpp"
 #include "rpltest.hpp"
 

diff --git a/rplcore/rplwriter.cpp b/rplcore/rplwriter.cpp
index 835655ff690cd36f4e96d676bdb547c49ccba86d..de35350a6832195db88398b1cafa2ee548dde5a5 100644 (file)
--- a/rplcore/rplwriter.cpp
+++ b/rplcore/rplwriter.cpp
@@ -12,6 +12,9 @@
  * Implementation of the abstract base class <code>RplWriter</code> and
  * the concrete derivation <code>RplFileWriter</code>.
  */
+/** @file rplcore/rplwriter.hpp
+ *
+ * @brief Definitions for a writer to an output media.
 
 #include "rplcore/rplcore.hpp"
 

diff --git a/rplexpr/rplasclasses.cpp b/rplexpr/rplasclasses.cpp
index 479a3874c8c6c145ae3d00be23eb85a6feb2c9fc..46b3d075d71fc115f0501b61aaf12d1e84784032 100644 (file)
--- a/rplexpr/rplasclasses.cpp
+++ b/rplexpr/rplasclasses.cpp
@@ -9,6 +9,10 @@
 /** @file
  * @brief Predefined classes of the virtual machine, e.g RplASInteger.
  */
+/** @file rplexpr/rplasclasses.hpp
+ *
+ * @brief Definitions for predefined classes of the virtual machine.
+ */
 
 #include "rplcore/rplcore.hpp"
 #include "rplexpr/rplexpr.hpp"

diff --git a/rplexpr/rplastree.cpp b/rplexpr/rplastree.cpp
index c894d7afa40bb6502fb1f4051e96b5275731ded5..d4b9d2a437c8c27797af73b077483bf6ab03b037 100644 (file)
--- a/rplexpr/rplastree.cpp
+++ b/rplexpr/rplastree.cpp
@@ -10,6 +10,11 @@
  * @brief Implementation of an Abstract Syntax Tree.
  *
  */
+/** @file rplexpr/rplastree.hpp
+ *
+ * @brief Definitions for an Abstract Syntax Tree.
+ *
+ */
 
 #include "rplcore/rplcore.hpp"
 #include "rplexpr/rplexpr.hpp"
@@ -957,7 +962,7 @@ void RplASExprStatement::dump(RplWriter& writer, int indent)
 
 /** @class RplASNode1 rplastree.hpp "rplexpr/rplastree.hpp"
  *
- * @brief Implements a inner node of the abstract syntax tree with one child.
+ * @brief Implements an inner node of the abstract syntax tree with one child.
  *
  * This class is an abstract class.
  */
@@ -1016,7 +1021,7 @@ void RplASNode1::dumpStatements(RplWriter& writer, int indent,
 
 /** @class RplASNode2 rplastree.hpp "rplexpr/rplastree.hpp"
  *
- * @brief Implements a inner node of the abstract syntax tree with two childs.
+ * @brief Implements an inner node of the abstract syntax tree with two childs.
  *
  * This class is an abstract class.
  */
@@ -1052,7 +1057,7 @@ void RplASNode2::setChild2(RplASItem* child2)
 
 /** @class RplASNode3 rplastree.hpp "rplexpr/rplastree.hpp"
  *
- * @brief Implements a inner node of the abstract syntax tree with 3 childs.
+ * @brief Implements an inner node of the abstract syntax tree with 3 childs.
  *
  * This class is an abstract class.
  */
@@ -1098,7 +1103,7 @@ void RplASNode3::setChild3(RplASItem* child3)
 
 /** @class RplASNode4 rplastree.hpp "rplexpr/rplastree.hpp"
  *
- * @brief Implements a inner node of the abstract syntax tree with 3 childs.
+ * @brief Implements an inner node of the abstract syntax tree with 3 childs.
  *
  * This class is an abstract class.
  */
@@ -1145,7 +1150,7 @@ void RplASNode4::setChild4(RplASItem* child4)
 
 /** @class RplASNode5 rplastree.hpp "rplexpr/rplastree.hpp"
  *
- * @brief Implements a inner node of the abstract syntax tree with 4 childs.
+ * @brief Implements an inner node of the abstract syntax tree with 4 childs.
  *
  * This class is an abstract class.
  */
@@ -1191,7 +1196,7 @@ void RplASNode5::setChild5(RplASItem* child5)
 
 /** @class RplASNode6 rplastree.hpp "rplexpr/rplastree.hpp"
  *
- * @brief Implements a inner node of the abstract syntax tree with 4 childs.
+ * @brief Implements an inner node of the abstract syntax tree with 4 childs.
  *
  * This class is an abstract class.
  */

diff --git a/rplexpr/rpllexer.cpp b/rplexpr/rpllexer.cpp
index 286f05b30ea26fe47de3a044cab0440ca8f6ee4b..b0bb76accb798be2c57cf4ab66a20cb5fe743f91 100644 (file)
--- a/rplexpr/rpllexer.cpp
+++ b/rplexpr/rpllexer.cpp
@@ -8,6 +8,9 @@
 /** @file
  * @brief Configurable scanner, wich separates syntactic symbols from an input media.
  */
+/** @file rplexpr/rpllexxer.hpp
+ * @brief Definitions for a configurable lexical analyser.
+ */
 
 #include "rplcore/rplcore.hpp"
 #include "rplexpr/rplexpr.hpp"

diff --git a/rplexpr/rplmfparser.cpp b/rplexpr/rplmfparser.cpp
index 54db19f45f09fea482dcf800f1374f9ca2148c62..31d4a37e6a7d86a970b4099477c5d1cb57dd429e 100644 (file)
--- a/rplexpr/rplmfparser.cpp
+++ b/rplexpr/rplmfparser.cpp
@@ -9,6 +9,9 @@
 /** @file
  * @brief A parser for the language <b>ML</b>.
  */
+/** @file
+ * @brief Definition for a parser for the language <b>ML</b>.
+ */
 
 #include "rplcore/rplcore.hpp"
 #include "rplexpr/rplexpr.hpp"

diff --git a/rplexpr/rplparser.cpp b/rplexpr/rplparser.cpp
index 3ead4a5961914ea981060b9d34928462a2360009..3f81c4531751f4cdbc5b99cff13bcefe467946c2 100644 (file)
--- a/rplexpr/rplparser.cpp
+++ b/rplexpr/rplparser.cpp
@@ -7,8 +7,13 @@
 */
 
 /** @file
+ *
  * @brief Generally usable parts of an parser, e.g. error handling.
  */
+/** @file rplexpr/rplparser.hpp
+ *
+ * @brief Definition of a generally usable parts of an parser.
+ */
 
 #include "rplcore/rplcore.hpp"
 #include "rplexpr/rplexpr.hpp"

diff --git a/rplexpr/rplsource.cpp b/rplexpr/rplsource.cpp
index 14a289462e23af636dc8c9c2ac7c098c6890871d..65153f3498f4bf43a3c43ab2ff2194d2d9dc604c 100644 (file)
--- a/rplexpr/rplsource.cpp
+++ b/rplexpr/rplsource.cpp
@@ -15,6 +15,10 @@
  * The <code>RplSource</code> combines several readers and build a uniquely
  * usable input stream.
  */
+/** @file rplexpr/rplsource.hpp
+ *
+ * @brief Definitions for reading from several input media.
+ */
 
 #include "rplcore/rplcore.hpp"
 #include "rplexpr/rplexpr.hpp"

diff --git a/rplexpr/rplvm.cpp b/rplexpr/rplvm.cpp
index 249274be2aba923db3e7176a169d1bb94f1e9c81..91c15186bc53dcd608c7e4ef708f5f028a581a4a 100644 (file)
--- a/rplexpr/rplvm.cpp
+++ b/rplexpr/rplvm.cpp
@@ -10,6 +10,10 @@
  *
  * @brief Implements an interpreter of an abstract syntax tree.
  */
+/** @file rplexpr/rplvm.hpp
+ *
+ * @brief Definitions for an interpreter of an abstract syntax tree.
+ */
 
 #include "rplcore/rplcore.hpp"
 #include "rplexpr/rplexpr.hpp"

diff --git a/rplmath/rplenigma.cpp b/rplmath/rplenigma.cpp
index ca217799a19cb1e5b3f2d545ed48a266e443e39a..eefa89b2b56f424d17c7ca6fbe48fed9ebf498a8 100644 (file)
--- a/rplmath/rplenigma.cpp
+++ b/rplmath/rplenigma.cpp
@@ -7,10 +7,15 @@
  * The original sources can be found on https://github.com/republib.
  */
 /** @file
+ *
  * @brief Implements encryption and decryption engines.
  */
+/** @file rplmath/rplenigma.hpp
+ *
+ * @brief Definitions for encryption and decryption engines.
+ */
 
-#include "rplmath.hpp"
+#include "rplmath/rplmath.hpp"
 
 /** @class RplEnigma::secret_t rplenigma.hpp "rplmath/rplenigma.hpp"
  *

diff --git a/rplmath/rplmatrix.cpp b/rplmath/rplmatrix.cpp
index d27e95db32b5aa35679f0707cdbd1b19ec9ee5d0..fe268b087f3fc3e8ac9ddcb380cb9a4bf875c9cf 100644 (file)
--- a/rplmath/rplmatrix.cpp
+++ b/rplmath/rplmatrix.cpp
@@ -8,6 +8,10 @@
 /** @file
  * @brief Implements 2 dimensional matrices.
  */
+/** @file rplmath/rplmatrix.hpp
+ *
+ * @brief Definitions for 2 dimensional matrices.
+ */
 
 #include "rplmath/rplmath.hpp"
 

diff --git a/rplmath/rplrandom.cpp b/rplmath/rplrandom.cpp
index 581a0c992f75692a9dc3641ecf76abb16e13ec01..5662f0d94cc4470738d11ba72ea73f749c3e8edb 100644 (file)
--- a/rplmath/rplrandom.cpp
+++ b/rplmath/rplrandom.cpp
@@ -7,8 +7,13 @@
  */
 
 /** @file
+ *
  * @brief Implements pseudo random generators.
  */
+/** @file rplmath/rplrandom.hpp
+ *
+ * @brief Definitions for pseudo random generators.
+ */
 #include "rplmath.hpp"
 
 /** @class RplRandom rplrandom.hpp "rplmath/rplrandom.hpp"