Fix some doxygen issues

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

View File

@@ -26,8 +26,8 @@
/**
@brief ConductorPropertiesDialog::ConductorPropertiesDialog
Constructor
@param conductor, conductor to edit propertie
@param parent, parent widget
@param conductor : conductor to edit propertie
@param parent : parent widget
*/
ConductorPropertiesDialog::ConductorPropertiesDialog(Conductor *conductor, QWidget *parent) :
QDialog(parent),
@@ -55,8 +55,8 @@ ConductorPropertiesDialog::~ConductorPropertiesDialog()
/**
@brief ConductorPropertiesDialog::PropertiesDialog
Static method for open and apply properties.
@param conductor, conductor to edit propertie
@param parent, parent widget
@param conductor : conductor to edit propertie
@param parent : parent widget
*/
void ConductorPropertiesDialog::PropertiesDialog(Conductor *conductor, QWidget *parent)
{

View File

@@ -24,7 +24,7 @@
/**
@brief ConductorPropertiesWidget::ConductorPropertiesWidget
Constructor
@param parent, paretn widget
@param parent : paretn widget
*/
ConductorPropertiesWidget::ConductorPropertiesWidget(QWidget *parent) :
QWidget(parent),
@@ -40,8 +40,8 @@ ConductorPropertiesWidget::ConductorPropertiesWidget(QWidget *parent) :
/**
@brief ConductorPropertiesWidget::ConductorPropertiesWidget
Constructor with properties
@param properties, properties to edit
@param parent, parent widget
@param properties : properties to edit
@param parent : parent widget
*/
ConductorPropertiesWidget::ConductorPropertiesWidget(const ConductorProperties &properties, QWidget *parent) :
QWidget(parent),

View File

@@ -37,7 +37,6 @@ DiagramPropertiesEditorDockWidget::DiagramPropertiesEditorDockWidget(QWidget *pa
Connect the diagram signal selectionChanged() to this slot selectionChanged();
If diagram = nullptr, we just disconnect all signal and remove editor.
@param diagram
@param diagram
*/
void DiagramPropertiesEditorDockWidget::setDiagram(Diagram *diagram)
{

View File

@@ -487,6 +487,7 @@ QModelIndex DynamicElementTextModel::indexFromText(
/**
@brief DynamicElementTextModel::undoForEditedText
@param deti
@param parent_undo
@return A QUndoCommand that describe all changes made for deti.
Each change made for deti is append as a child of the returned QUndoCommand.
In other word, if the returned QUndoCommand have no child,

View File

@@ -61,10 +61,13 @@ class NewConductorPotentialSelector : public AbstractPotentialSelector
/**
@brief getPotential
Get the conductor propertie of the potential at terminal, and the number of wire in this potential.
Get the conductor propertie of the potential at terminal,
and the number of wire in this potential.
@param terminal
@param properties
@param seq_num
@param number
@param properties_list
@param c_list
*/
void getPotential(Terminal *terminal, autonum::sequentialNumbers &seq_num , int &number, QList<ConductorProperties> &properties_list, QList<Conductor*> &c_list)
{