From: hama Date: Sun, 10 Aug 2014 00:59:30 +0000 (+0200) Subject: dayly work X-Git-Url: https://gitweb.hamatoma.de/?a=commitdiff_plain;h=4c277cdcd968502c087d05605fbc3d698dd03cb4;p=reqt dayly work --- diff --git a/rplcore/rplconfig.cpp b/rplcore/rplconfig.cpp index 44d2d75..ba96571 100644 --- 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 5760dda..2dbd976 100644 --- 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 16ffc29..dcc77f4 100644 --- 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 f85bcae..b998d68 100644 --- 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 #include diff --git a/rplcore/rplqstring.cpp b/rplcore/rplqstring.cpp index 664a186..b0d64af 100644 --- a/rplcore/rplqstring.cpp +++ b/rplcore/rplqstring.cpp @@ -9,6 +9,10 @@ /** @file * @brief Missed operation for QStrings. */ +/** @file rplcore/rplqstring.hpp + * + * @brief Definitions for missed operation for QStrings. + */ #include "rplcore/rplcore.hpp" diff --git a/rplcore/rplstring.cpp b/rplcore/rplstring.cpp index d98d746..a9c4b83 100644 --- 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 QByteArrays. + * @brief Missed operations for QByteArrays. + */ +/** @file rplcore/rplstring.cpp + * + * @brief Definitions for missed operations for QByteArrays. */ #include "rplcore.hpp" diff --git a/rplcore/rplterminator.cpp b/rplcore/rplterminator.cpp index 9270bef..a223ddd 100644 --- 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 340611b..3fd6a3e 100644 --- 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 835655f..de35350 100644 --- a/rplcore/rplwriter.cpp +++ b/rplcore/rplwriter.cpp @@ -12,6 +12,9 @@ * Implementation of the abstract base class RplWriter and * the concrete derivation RplFileWriter. */ +/** @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 479a387..46b3d07 100644 --- 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 c894d7a..d4b9d2a 100644 --- 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 286f05b..b0bb76a 100644 --- 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 54db19f..31d4a37 100644 --- a/rplexpr/rplmfparser.cpp +++ b/rplexpr/rplmfparser.cpp @@ -9,6 +9,9 @@ /** @file * @brief A parser for the language ML. */ +/** @file + * @brief Definition for a parser for the language ML. + */ #include "rplcore/rplcore.hpp" #include "rplexpr/rplexpr.hpp" diff --git a/rplexpr/rplparser.cpp b/rplexpr/rplparser.cpp index 3ead4a5..3f81c45 100644 --- 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 14a2894..65153f3 100644 --- a/rplexpr/rplsource.cpp +++ b/rplexpr/rplsource.cpp @@ -15,6 +15,10 @@ * The RplSource 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 249274b..91c1518 100644 --- 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 ca21779..eefa89b 100644 --- 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 d27e95d..fe268b0 100644 --- 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 581a0c9..5662f0d 100644 --- 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"