kotschak/qelectrotech-source-mirror
0
0
Fork 0
mirror of https://github.com/qelectrotech/qelectrotech-source-mirror.git synced 2026-01-25 11:29:58 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Fix some doxygen issues

Browse Source
This commit is contained in:
Simon De Backer
2020-08-20 21:57:35 +02:00
parent 8626ca5d1b
commit 0c00d83b27
57 changed files with 270 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
sources/dataBase/projectdatabase.cpp
View File

@@ -77,7 +77,8 @@ QETProject *projectDataBase::project() const {
/**
@brief projectDataBase::newQuery
@return a QSqlquery with @query as query and the internal database of this class as database to use.
@return a QSqlquery with query as query
and the internal database of this class as database to use.
*/
QSqlQuery projectDataBase::newQuery(const QString &query) {
return QSqlQuery(query, m_data_base);
@@ -528,12 +529,10 @@ QHash<QString, QString> projectDataBase::elementInfoToString(Element *elmt)
/**
@brief projectDataBase::exportDb
@param db
@param parent
@param caption
@param dir
@param filter
@param selectedFilter
@param options
*/
void projectDataBase::exportDb(projectDataBase *db, QWidget *parent, const QString &caption, const QString &dir)
{

4
sources/dataBase/projectdatabase.h
View File

@@ -30,8 +30,8 @@ class Diagram;
/**
@brief The projectDataBase class
This class wrap a sqlite data base where you can find several thing about
the content of a project.
This class wrap a sqlite data base where you can find several thing
about the content of a project.
*
@note this class is still in developement.
*/

38
sources/dataBase/ui/elementquerywidget.cpp
View File

@@ -105,7 +105,7 @@ ElementQueryWidget::~ElementQueryWidget() {
/**
@brief ElementQueryWidget::setQuery
@param query
Set the current query to @query.
Set the current query to query.
If it's possible, rebuild the state of the widget from the query
*/
void ElementQueryWidget::setQuery(const QString &query)
@@ -370,14 +370,15 @@ QString ElementQueryWidget::queryStr() const
}
/**
* @brief ElementQueryWidget::setGroupBy
* Add the query instruction GROUP BY.
* @param text : the text of the GROUP BY instruction:
* ex : if @text = designation, the query will contain "GROUP BY designation"
* @param set :
* true by default -> GROUP BY will be used.
* false -> GROUP BY will be not used
*/
@brief ElementQueryWidget::setGroupBy
Add the query instruction GROUP BY.
@param text : the text of the GROUP BY instruction:
ex : if text = designation,
the query will contain "GROUP BY designation"
@param set :
true by default -> GROUP BY will be used.
false -> GROUP BY will be not used
*/
void ElementQueryWidget::setGroupBy(QString text, bool set)
{
if (set) {
@@ -389,15 +390,16 @@ void ElementQueryWidget::setGroupBy(QString text, bool set)
}
/**
* @brief ElementQueryWidget::setCount
* Add the query instruction COUNT.
* Unlike setGroupBy, you have to write the entire sentance.
* ex : text = "COUNT(*) AS designation_qty". the query will contain what you write.
* @param text : the count instruction
* @param set :
* true by default -> count will be used.
* false -> count will be not used.
*/
@brief ElementQueryWidget::setCount
Add the query instruction COUNT.
Unlike setGroupBy, you have to write the entire sentance.
ex : text = "COUNT(*) AS designation_qty".
the query will contain what you write.
@param text : the count instruction
@param set :
true by default -> count will be used.
false -> count will be not used.
*/
void ElementQueryWidget::setCount(QString text, bool set)
{
if (set) {