added docs

This commit is contained in:
Andrei Yankovich 2020-09-26 19:49:38 +03:00
parent d4f724d80a
commit cbd40e2cc8
7 changed files with 17 additions and 16 deletions

View File

@ -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);
}

View File

@ -3,8 +3,7 @@
namespace QH {
namespace PKG {
CloseConnection::CloseConnection()
{
CloseConnection::CloseConnection() {
}
}

View File

@ -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

View File

@ -110,7 +110,7 @@ public:
exampleMember = q.value("exampleMember").toInt();
return isValid();
}
* \code
* \endcode
*/
virtual bool fromSqlRecord(const QSqlRecord& q);

View File

@ -133,16 +133,19 @@ protected:
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<const QH::PKG::DBObject *> &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;

View File

@ -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

View File

@ -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