From cbd40e2cc83ac4bcf7c4f53ce38ca2fb0a3ec050 Mon Sep 17 00:00:00 2001 From: EndrII Date: Sat, 26 Sep 2020 19:49:38 +0300 Subject: [PATCH] added docs --- Heart/AbstractSpace/hostaddress.cpp | 2 +- Heart/AbstractSpace/packages/closeconnection.cpp | 3 +-- Heart/AbstractSpace/packages/closeconnection.h | 4 ++-- Heart/DataBaseSpace/packages/dbobject.h | 2 +- Heart/DataBaseSpace/sqldbwriter.h | 13 ++++++++----- README.md | 8 +++----- doxygen.conf | 1 + 7 files changed, 17 insertions(+), 16 deletions(-) diff --git a/Heart/AbstractSpace/hostaddress.cpp b/Heart/AbstractSpace/hostaddress.cpp index f2637b8b..322b50a2 100644 --- a/Heart/AbstractSpace/hostaddress.cpp +++ b/Heart/AbstractSpace/hostaddress.cpp @@ -17,7 +17,7 @@ HostAddress::HostAddress(const QString &other, int port): setPort(port); } -HostAddress::HostAddress(const QHostAddress::SpecialAddress &other, int port): +HostAddress::HostAddress(const SpecialAddress &other, int port): QHostAddress(other) { setPort(port); } diff --git a/Heart/AbstractSpace/packages/closeconnection.cpp b/Heart/AbstractSpace/packages/closeconnection.cpp index b2b14ae9..aa345b2a 100644 --- a/Heart/AbstractSpace/packages/closeconnection.cpp +++ b/Heart/AbstractSpace/packages/closeconnection.cpp @@ -3,8 +3,7 @@ namespace QH { namespace PKG { -CloseConnection::CloseConnection() -{ +CloseConnection::CloseConnection() { } } diff --git a/Heart/AbstractSpace/packages/closeconnection.h b/Heart/AbstractSpace/packages/closeconnection.h index 4e75ac7d..510d0cea 100644 --- a/Heart/AbstractSpace/packages/closeconnection.h +++ b/Heart/AbstractSpace/packages/closeconnection.h @@ -12,9 +12,9 @@ namespace PKG { * This neede becouse QAbstractSocket emit error when connection closed from remote node. * * From QtDocumentation : - * \code{cpp} + * + * * If the remote host closes the connection, QAbstractSocket will emit errorOccurred(QAbstractSocket::RemoteHostClosedError), during which the socket state will still be ConnectedState, and then the disconnected() signal will be emitted. - * \endcond * */ class HEARTSHARED_EXPORT CloseConnection: public AbstractData diff --git a/Heart/DataBaseSpace/packages/dbobject.h b/Heart/DataBaseSpace/packages/dbobject.h index 8d4ef124..cc5ad87f 100644 --- a/Heart/DataBaseSpace/packages/dbobject.h +++ b/Heart/DataBaseSpace/packages/dbobject.h @@ -110,7 +110,7 @@ class HEARTSHARED_EXPORT DBObject : public AbstractData exampleMember = q.value("exampleMember").toInt(); return isValid(); } - * \code + * \endcode */ virtual bool fromSqlRecord(const QSqlRecord& q); diff --git a/Heart/DataBaseSpace/sqldbwriter.h b/Heart/DataBaseSpace/sqldbwriter.h index be43bdf5..f5907fd6 100644 --- a/Heart/DataBaseSpace/sqldbwriter.h +++ b/Heart/DataBaseSpace/sqldbwriter.h @@ -133,16 +133,19 @@ class HEARTSHARED_EXPORT SqlDBWriter : public iObjectProvider virtual bool saveQuery(const QH::PKG::DBObject *ptr) const; /** - * @brief selectQuery generate select query to database from parameters - * @param returnList - return values - * @param table - table name of query - * @param key - compare key (column) for select is default it is id - * @param val - compare value + * @brief selectQuery generate select query to database from parameters. + * @param requestObject This is template object for generate select query. + * @param result This isreturn values * @return true if all goodelse false */ virtual bool selectQuery(const QH::PKG::DBObject &requestObject, QList &result); + /** + * @brief deleteQuery This method prepare the delete object query. + * @param deleteObject This is tempalte object for generate a delete query. + * @return true if query generated successful. + */ virtual bool deleteQuery(const QH::PKG::DBObject *deleteObject) const; QSqlDatabase db; diff --git a/README.md b/README.md index f7b91e89..4fb375c0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # QuasarApp Heart -QuasarApp Heart - it is base backend for C++/Qt projects. +QuasarApp Heart - it is base backend for C++/Qt projects. This library support work with databases and work with lite network requests. ## Futures This library consists of two levels (AbstractNode level and DataBaseNode level). @@ -11,9 +11,8 @@ This library consists of two levels (AbstractNode level and DataBaseNode level). ### AbstractNode level (0) #### Description -The AbstractNode level implement only base functons of create new work threads and parsing packages. - -For more information see QuasarApp Heart documentation or QH namespace. +The AbstractNode level implement only base functions of create a new work threads and parsing packages. +For more information see QuasarApp Heart documentation, QH namespace. ### DataBaseNode level (1) #### Description @@ -24,7 +23,6 @@ The DataBaseNode level implement methods and packages for work with databases. T This level is still in develop. ## Build and Include - ### For cmake projects * cd yourRepo diff --git a/doxygen.conf b/doxygen.conf index b9b416a7..ec673fc7 100644 --- a/doxygen.conf +++ b/doxygen.conf @@ -877,6 +877,7 @@ RECURSIVE = YES # run. EXCLUDE = ./Heart/Qt-Secret \ + ./Heart/NetworkSpace \ ./Heart/CMakeFiles # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or