kotschak/qelectrotech-source-mirror
0
0
Fork 0
mirror of https://github.com/qelectrotech/qelectrotech-source-mirror.git synced 2026-02-20 10:39:59 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix some doxygen issues

Browse Source
This commit is contained in:
Simon De Backer
2020-08-18 21:28:52 +02:00
parent ef15013715
commit 8e956df8d8
33 changed files with 204 additions and 159 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
sources/ui/bomexportdialog.cpp
View File

@@ -25,10 +25,12 @@
#include <QSqlError>
#include <QSqlRecord>
/**
* @brief BOMExportDialog::BOMExportDialog
* @param parent
*/
@brief BOMExportDialog::BOMExportDialog
@param project
@param parent
*/
BOMExportDialog::BOMExportDialog(QETProject *project, QWidget *parent) :
QDialog(parent),
ui(new Ui::BOMExportDialog),
@@ -43,17 +45,17 @@ BOMExportDialog::BOMExportDialog(QETProject *project, QWidget *parent) :
}
/**
* @brief BOMExportDialog::~BOMExportDialog
*/
@brief BOMExportDialog::~BOMExportDialog
*/
BOMExportDialog::~BOMExportDialog()
{
delete ui;
}
/**
* @brief BOMExportDialog::exec
* @return
*/
@brief BOMExportDialog::exec
@return
*/
int BOMExportDialog::exec()
{
auto r = QDialog::exec();
@@ -156,6 +158,10 @@ QString BOMExportDialog::getBom()
return return_string;
}
/**
@brief BOMExportDialog::on_m_format_as_bom_clicked
@param checked
*/
void BOMExportDialog::on_m_format_as_bom_clicked(bool checked) {
m_query_widget->setGroupBy("designation", checked);
m_query_widget->setCount("COUNT(*) AS designation_qty", checked);

4
sources/ui/bomexportdialog.h
View File

@@ -28,8 +28,8 @@ class BOMExportDialog;
}
/**
* @brief The BOMExportDialog class
*/
@brief The BOMExportDialog class
*/
class BOMExportDialog : public QDialog
{
Q_OBJECT

2
sources/ui/diagramcontextwidget.cpp
View File

@@ -61,7 +61,7 @@ DiagramContext DiagramContextWidget::context() const
/**
@brief DiagramContextWidget::setContext
Load the content from @context into this widget
Load the content from context into this widget
@param context
*/
void DiagramContextWidget::setContext (const DiagramContext &context)

4
sources/ui/dynamicelementtextitemeditor.cpp
View File

@@ -136,7 +136,7 @@ void DynamicElementTextItemEditor::apply()
/**
@brief DynamicElementTextItemEditor::setCurrentText
Expand and select the item for text @text
Expand and select the item for text text
@param text
*/
void DynamicElementTextItemEditor::setCurrentText(DynamicElementTextItem *text)
@@ -153,7 +153,7 @@ void DynamicElementTextItemEditor::setCurrentText(DynamicElementTextItem *text)
/**
@brief DynamicElementTextItemEditor::setCurrentGroup
Expand and select the item for group @group
Expand and select the item for group group
@param group
*/
void DynamicElementTextItemEditor::setCurrentGroup(ElementTextItemGroup *group)

18
sources/ui/dynamicelementtextmodel.cpp
View File

@@ -851,7 +851,7 @@ void DynamicElementTextModel::removeGroup(ElementTextItemGroup *group)
/**
@brief DynamicElementTextModel::textAddedToGroup
Add the text @text to the group @group
Add the text text to the group group
@param deti
@param group
*/
@@ -880,7 +880,7 @@ void DynamicElementTextModel::removeTextFromGroup(DynamicElementTextItem *deti,
@brief DynamicElementTextModel::groupFromIndex
@param index
@return the group associated with index. Return value can be nullptr
@Index can be a child of an index associated with a group
Index can be a child of an index associated with a group
and can be the column 0 or 1.
*/
ElementTextItemGroup *DynamicElementTextModel::groupFromIndex(
@@ -941,8 +941,8 @@ QModelIndex DynamicElementTextModel::indexFromGroup(
/**
@brief DynamicElementTextModel::indexIsText
@param index
@return True if @index represente a text, both for the column 0 and 1.
Return false if @index is a child of an index associated to a text.
@return True if index represente a text, both for the column 0 and 1.
Return false if index is a child of an index associated to a text.
*/
bool DynamicElementTextModel::indexIsText(const QModelIndex &index) const
{
@@ -1191,7 +1191,7 @@ QStringList DynamicElementTextModel::mimeTypes() const
/**
@brief DynamicElementTextModel::enableSourceText
Enable the good field, according to the current source of text,
for the edited text @deti
for the edited text deti
@param deti
@param tf
*/
@@ -1320,7 +1320,7 @@ void DynamicElementTextModel::itemDataChanged(QStandardItem *qsi)
}
}
//We emit the signal only if @qsi is in the second column,
//We emit the signal only if qsi is in the second column,
//because the data are stored on this column
//the first column is use only for display the title of the property,
//except for the name of texts group
@@ -1332,7 +1332,8 @@ void DynamicElementTextModel::itemDataChanged(QStandardItem *qsi)
/**
@brief DynamicElementTextModel::setConnection
Set up the connection for @deti to keep up to date the data of this model and the text.
Set up the connection for deti to keep up to date
the data of this model and the text.
Is notably use with the use of QUndoCommand.
@param deti - text to setup connection
@param set - true = set connection - false unset connection
@@ -1372,7 +1373,8 @@ void DynamicElementTextModel::setConnection(DynamicElementTextItem *deti, bool s
/**
@brief DynamicElementTextModel::setConnection
Set up the connection for @group to keep up to date the data of this model and the group.
Set up the connection for group to keep up to date
the data of this model and the group.
Is notably use with the use of QUndoCommand.
@param group group to setup the connection
@param set true = set connection - false unset connection

5
sources/ui/elementinfowidget.cpp
View File

@@ -51,7 +51,7 @@ ElementInfoWidget::~ElementInfoWidget()
/**
@brief ElementInfoWidget::setElement
Set @element to be the edited element
Set element to be the edited element
@param element
*/
void ElementInfoWidget::setElement(Element *element)
@@ -189,7 +189,8 @@ void ElementInfoWidget::buildInterface()
/**
@brief ElementInfoWidget::infoPartWidgetForKey
@param key
@return the ElementInfoPartWidget with key @key, if not found return nullptr;
@return the ElementInfoPartWidget with key key,
if not found return nullptr;
*/
ElementInfoPartWidget *ElementInfoWidget::infoPartWidgetForKey(const QString &key) const
{

32
sources/ui/elementpropertieswidget.cpp
View File

@@ -49,9 +49,11 @@ ElementPropertiesWidget::ElementPropertiesWidget(Element *elmt, QWidget *parent)
/**
@brief ElementPropertiesWidget::ElementPropertiesWidget
Same as default constructor, the edited element, is the parent element of @text.
The only difference with default constructor, is that the current tab is the tab for dynamic texts,
and the item in the tree that represent @text is expanded and selected.
Same as default constructor, the edited element,
is the parent element of text.
The only difference with default constructor,
is that the current tab is the tab for dynamic texts,
and the item in the tree that represent text is expanded and selected.
@param text
@param parent
*/
@@ -70,9 +72,11 @@ ElementPropertiesWidget::ElementPropertiesWidget(DynamicElementTextItem *text, Q
/**
@brief ElementPropertiesWidget::ElementPropertiesWidget
Same as default constructor, the edited element, is the parent element of @group.
The only difference with default constructor, is that the current tab is the tab for dynamic texts,
and the item in the tree that represent @group is expanded and selected.
Same as default constructor, the edited element,
is the parent element of group.
The only difference with default constructor,
is that the current tab is the tab for dynamic texts,
and the item in the tree that represent group is expanded and selected.
@param group
@param parent
*/
@@ -92,7 +96,7 @@ ElementPropertiesWidget::ElementPropertiesWidget(ElementTextItemGroup *group, QW
/**
@brief ElementPropertiesWidget::setElement
Set @element to be the edited element
Set element to be the edited element
@param element
*/
void ElementPropertiesWidget::setElement(Element *element)
@@ -119,8 +123,11 @@ void ElementPropertiesWidget::setElement(Element *element)
/**
@brief ElementPropertiesWidget::setDynamicText
convenience function: same as call : ElementPropertiesWidget::setElement, with parameter the parent element of @text.
Set the dynamics text tab as current tab, expand and select the item that represent @text
convenience function:
same as call : ElementPropertiesWidget::setElement,
with parameter the parent element of text.
Set the dynamics text tab as current tab,
expand and select the item that represent text
@param text
*/
void ElementPropertiesWidget::setDynamicText(DynamicElementTextItem *text)
@@ -142,8 +149,11 @@ void ElementPropertiesWidget::setDynamicText(DynamicElementTextItem *text)
/**
@brief ElementPropertiesWidget::setTextsGroup
Conveniance function : same as call : ElementPropertiesWidget::setElement, with parameter the parent element of @group.
Set the dynamics text tab as current tab, expand and select the item that represent @group
Conveniance function :
same as call : ElementPropertiesWidget::setElement,
with parameter the parent element of group.
Set the dynamics text tab as current tab,
expand and select the item that represent group
@param group
*/
void ElementPropertiesWidget::setTextsGroup(ElementTextItemGroup *group)

2
sources/ui/inditextpropertieswidget.cpp
View File

@@ -61,7 +61,7 @@ IndiTextPropertiesWidget::~IndiTextPropertiesWidget() {
/**
@brief IndiTextPropertiesWidget::setText
@param text : set @text as edited text
@param text : set text as edited text
*/
void IndiTextPropertiesWidget::setText(IndependentTextItem *text)
{

2
sources/ui/linksingleelementwidget.cpp
View File

@@ -593,7 +593,7 @@ void LinkSingleElementWidget::on_m_unlink_pb_clicked()
/**
@brief LinkSingleElementWidget::on_m_tree_widget_itemDoubleClicked
Highlight the element represented by @item
Highlight the element represented by item
@param item
@param column
*/

9
sources/ui/linksingleelementwidget.h
View File

@@ -28,12 +28,13 @@ namespace Ui {
}
/**
* @brief The LinkSingleElementWidget class
@brief The LinkSingleElementWidget class
this class provide a widget to select an element to be linked
to the element given in the constructor.
The element given in constructor must be linked with only one other element (like report or slave element).
This widget detect automaticaly the kind of element given in the constructor and
search all element that can be linked with it.
The element given in constructor must be linked with only
one other element (like report or slave element).
This widget detect automaticaly the kind of element given in
the constructor and search all element that can be linked with it.
If the element is already linked, the widget ask user to unlink.
This widget embedded the diagram command for undo/redo the action
*/

4
sources/ui/potentialselectordialog.h
View File

@@ -53,8 +53,8 @@ namespace Ui {
the properties of the two existing potential,
to apply it for the new potential.
Each constructor have a QUndoCommand @parent_undo for parameter
If @parent_undo isn't null, when user click on OK button,
Each constructor have a QUndoCommand parent_undo for parameter
If parent_undo isn't null, when user click on OK button,
the dialog will use the parent-undo
as parent of the undo command that describe the changes.
If parent_undo is null, the created undo-command is push

2
sources/ui/shapegraphicsitempropertieswidget.cpp
View File

@@ -55,7 +55,7 @@ ShapeGraphicsItemPropertiesWidget::~ShapeGraphicsItemPropertiesWidget()
/**
@brief ShapeGraphicsItemPropertiesWidget::setItem
Set @shape as the current edited item
Set shape as the current edited item
@param shape
*/
void ShapeGraphicsItemPropertiesWidget::setItem(QetShapeItem *shape)

3
sources/ui/titleblockpropertieswidget.cpp
View File

@@ -322,7 +322,8 @@ void TitleBlockPropertiesWidget::initDialog(const bool &current_date, QETProjec
/**
@brief TitleBlockPropertiesWidget::getIndexFor
Find the index of the combo box for the title block @tbt_name available on the collection @collection
Find the index of the combo box for
the title block tbt_name available on the collection collection
@param tbt_name : title block name
@param collection : title block collection
@return the index of the title block or -1 if no match

6
sources/ui/xrefpropertieswidget.cpp
View File

@@ -112,7 +112,7 @@ void XRefPropertiesWidget::buildUi()
/**
@brief XRefPropertiesWidget::saveProperties
Save the properties of the type define at @index of the combo box m_type_cb
Save the properties of the type define at index of the combo box m_type_cb
@param index
*/
void XRefPropertiesWidget::saveProperties(int index) {
@@ -130,10 +130,6 @@ void XRefPropertiesWidget::saveProperties(int index) {
else
xrp.setSnapTo(XRefProperties::Label);
if(ui->m_xrefpos_cb->itemData(ui->m_xrefpos_cb->currentIndex()).toString() == "bottom") xrp.setXrefPos(Qt::AlignBottom);
else if(ui->m_xrefpos_cb->itemData(ui->m_xrefpos_cb->currentIndex()).toString() == "top") xrp.setXrefPos(Qt::AlignTop);
else if(ui->m_xrefpos_cb->itemData(ui->m_xrefpos_cb->currentIndex()).toString() == "left") xrp.setXrefPos(Qt::AlignLeft);