Fix some doxygen issues

This commit is contained in:
Simon De Backer
2020-08-19 21:24:48 +02:00
parent f5725531c2
commit 666f20856e
21 changed files with 149 additions and 93 deletions

View File

@@ -25,6 +25,11 @@
#include <QHBoxLayout>
#include <QLabel>
/**
@brief TerminalEditor::TerminalEditor
@param editor
@param parent
*/
TerminalEditor::TerminalEditor(QETElementEditor* editor, QWidget* parent):
ElementItemEditor(editor, parent) {
m_part = nullptr;
@@ -33,10 +38,14 @@ TerminalEditor::TerminalEditor(QETElementEditor* editor, QWidget* parent):
}
/**
@brief TerminalEditor::TerminalEditor
Constructeur
@param editor L'editeur d'element concerne
@param term La borne a editer
@param parent QWidget parent de ce widget
@param editor :
L'editeur d'element concerne
@param terms :
La borne a editer
@param parent :
QWidget parent de ce widget
*/
TerminalEditor::TerminalEditor(QETElementEditor *editor, QList<PartTerminal *> &terms, QWidget *parent) :
ElementItemEditor(editor, parent),
@@ -45,6 +54,9 @@ TerminalEditor::TerminalEditor(QETElementEditor *editor, QList<PartTerminal *> &
init();
}
/**
@brief TerminalEditor::init
*/
void TerminalEditor::init() {
qle_x = new QDoubleSpinBox();
qle_y = new QDoubleSpinBox();
@@ -80,7 +92,10 @@ void TerminalEditor::init() {
updateForm();
}
/// Destructeur
/**
@brief TerminalEditor::~TerminalEditor
Destructeur
*/
TerminalEditor::~TerminalEditor() {
}
@@ -174,6 +189,9 @@ void TerminalEditor::updateTerminalO() {
m_locked = false;
}
/**
@brief TerminalEditor::updateXPos
*/
void TerminalEditor::updateXPos() {
if (m_locked) return;
m_locked = true;
@@ -192,6 +210,9 @@ void TerminalEditor::updateXPos() {
m_locked=false;
}
/**
@brief TerminalEditor::updateYPos
*/
void TerminalEditor::updateYPos() {
if (m_locked) return;
m_locked = true;

View File

@@ -25,6 +25,7 @@ class QDoubleSpinBox;
class QComboBox;
/**
@brief The TerminalEditor class
This class provides a widget to edit terminals within the element editor.
The class is capable to change the values of multiple parts of the same time.
The displayed values are from the first selected element

View File

@@ -96,9 +96,9 @@ void TextEditor::disconnectEditConnection() {
/**
@brief TextEditor::setPart
Set the current text to edit.
Set @part to nullptr to clear the current text.
Set part to nullptr to clear the current text.
@param part : part to edit
@return : return if @part is a partext or nullptr, else return false
@return if part is a partext or nullptr, else return false
*/
bool TextEditor::setPart(CustomElementPart *part) {
if (!part) {