Fix some doxygen issues

sources/ElementsCollection/xmlelementcollection.cpp

@@ -326,7 +326,7 @@ QDomElement XmlElementCollection::directory(const QString &path) const
 	path : import/dir1/dir2/dir3/myElement.elmt
 	If the path doesn't exist, he was created.
 	If the element already exist, do nothing.
-	@param location, location of the element
+	@param location : location of the element
 	@return the collection path of the added item
 	or a null QString if element can't be added.
 */

sources/ElementsCollection/xmlelementcollection.h

@@ -67,35 +67,35 @@ class XmlElementCollection : public QObject
 		ElementsLocation copyElement(ElementsLocation &source, ElementsLocation &destination, const QString& rename = QString());
 
 	signals:
-			/**
+		/**
-				@brief elementAdded
+			@brief elementAdded
-				This signal is emited when a element is added to this collection
+			This signal is emited when a element is added to this collection
-				@param collection_path, the path of element in this collection
+			@param collection_path : the path of element in this collection
-			*/
+		*/
 		void elementAdded(QString collection_path);
-			/**
+		/**
-				@brief elementChanged
+			@brief elementChanged
-				This signal is emited when the defintion of the element at path was changed
+			This signal is emited when the defintion of the element at path was changed
-				@param collection_path, the path of this element in this collection
+			@param collection_path : the path of this element in this collection
-			*/
+		*/
 		void elementChanged (QString collection_path);
-			/**
+		/**
-				@brief elementRemoved
+			@brief elementRemoved
-				This signal is emited when an element is removed to this collection
+			This signal is emited when an element is removed to this collection
-				@param collection_path, the path of the removed element in this collection
+			@param collection_path : the path of the removed element in this collection
-			*/
+		*/
 		void elementRemoved(QString collection_path);
-			/**
+		/**
-				@brief directorieAdded
+			@brief directorieAdded
-				This signal is emited when a directorie is added to this collection
+			This signal is emited when a directorie is added to this collection
-				@param collection_path, the path of the new directorie
+			@param collection_path : the path of the new directorie
-			*/
+		*/
 		void directorieAdded(QString collection_path);
-			/**
+		/**
-				@brief directoryRemoved
+			@brief directoryRemoved
-				This signal is emited when a directory is removed to this collection
+			This signal is emited when a directory is removed to this collection
-				@param collection_path, the path of the removed directory
+			@param collection_path : the path of the removed directory
-			*/
+		*/
 		void directoryRemoved(QString collection_path);
 
 	private:

sources/ElementsCollection/xmlprojectelementcollectionitem.cpp

@@ -1,19 +1,19 @@
 /*
-		Copyright 2006-2020 The QElectroTech Team
+	Copyright 2006-2020 The QElectroTech Team
-		This file is part of QElectroTech.
+	This file is part of QElectroTech.
 
-		QElectroTech is free software: you can redistribute it and/or modify
+	QElectroTech is free software: you can redistribute it and/or modify
-		it under the terms of the GNU General Public License as published by
+	it under the terms of the GNU General Public License as published by
-		the Free Software Foundation, either version 2 of the License, or
+	the Free Software Foundation, either version 2 of the License, or
-		(at your option) any later version.
+	(at your option) any later version.
 
-		QElectroTech is distributed in the hope that it will be useful,
+	QElectroTech is distributed in the hope that it will be useful,
-		but WITHOUT ANY WARRANTY; without even the implied warranty of
+	but WITHOUT ANY WARRANTY; without even the implied warranty of
-		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-		GNU General Public License for more details.
+	GNU General Public License for more details.
 
-		You should have received a copy of the GNU General Public License
+	You should have received a copy of the GNU General Public License
-		along with QElectroTech. If not, see <http://www.gnu.org/licenses/>.
+	along with QElectroTech.  If not, see <http://www.gnu.org/licenses/>.
 */
 #include "qetproject.h"
 #include "xmlelementcollection.h"
@@ -236,6 +236,7 @@ void XmlProjectElementCollectionItem::setUpIcon()
 	@brief XmlProjectElementCollectionItem::populate
 	Create the childs of this item
 	@param set_data : if true, call setUpData for every child of this item
+	@param hide_element : bool
 */
 void XmlProjectElementCollectionItem::populate(bool set_data, bool hide_element)
 {

sources/ElementsCollection/xmlprojectelementcollectionitem.h

@@ -1,19 +1,19 @@
 /*
-		Copyright 2006-2020 The QElectroTech Team
+	Copyright 2006-2020 The QElectroTech Team
-		This file is part of QElectroTech.
+	This file is part of QElectroTech.
 
-		QElectroTech is free software: you can redistribute it and/or modify
+	QElectroTech is free software: you can redistribute it and/or modify
-		it under the terms of the GNU General Public License as published by
+	it under the terms of the GNU General Public License as published by
-		the Free Software Foundation, either version 2 of the License, or
+	the Free Software Foundation, either version 2 of the License, or
-		(at your option) any later version.
+	(at your option) any later version.
 
-		QElectroTech is distributed in the hope that it will be useful,
+	QElectroTech is distributed in the hope that it will be useful,
-		but WITHOUT ANY WARRANTY; without even the implied warranty of
+	but WITHOUT ANY WARRANTY; without even the implied warranty of
-		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-		GNU General Public License for more details.
+	GNU General Public License for more details.
 
-		You should have received a copy of the GNU General Public License
+	You should have received a copy of the GNU General Public License
-		along with QElectroTech. If not, see <http://www.gnu.org/licenses/>.
+	along with QElectroTech.  If not, see <http://www.gnu.org/licenses/>.
 */
 #ifndef XMLPROJECTELEMENTCOLLECTIONITEM2_H
 #define XMLPROJECTELEMENTCOLLECTIONITEM2_H
@@ -25,7 +25,8 @@ class QETProject;
 
 /**
 	@brief The XmlProjectElementCollectionItem class
-	This class specialise ElementCollectionItem for manage an xml collection embedded in a project.
+	This class specialise ElementCollectionItem
+	for manage an xml collection embedded in a project.
 */
 class XmlProjectElementCollectionItem : public ElementCollectionItem
 {

sources/autoNum/ui/selectautonumw.cpp

@@ -80,8 +80,10 @@ SelectAutonumW::~SelectAutonumW()
 }
 
 /**
-	@brief SelectAutonumW::setCurrentContext
+	@brief SelectAutonumW::setContext
-	build the context of current diagram selected in the @diagram_chooser QcomboBox
+	build the context of current diagram
+	selected in the diagram_chooser QcomboBox
+	@param context
 */
 void SelectAutonumW::setContext(const NumerotationContext &context) {
 	m_context = context;
@@ -110,7 +112,7 @@ void SelectAutonumW::setContext(const NumerotationContext &context) {
 
 /**
 	@brief SelectAutonumW::toNumContext
-	@return the content to @num_part_list to NumerotationContext
+	@return the content to num_part_list to NumerotationContext
 */
 NumerotationContext SelectAutonumW::toNumContext() const {
 	NumerotationContext nc;
@@ -120,7 +122,7 @@ NumerotationContext SelectAutonumW::toNumContext() const {
 
 /**
 	@brief SelectAutonumW::on_add_button_clicked
- *	Action on add_button, add a @NumPartEditor
+ *	Action on add_button, add a NumPartEditor
 */
 void SelectAutonumW::on_add_button_clicked()
 {
@@ -134,7 +136,7 @@ void SelectAutonumW::on_add_button_clicked()
 
 /**
 	@brief SelectAutonumW::on_remove_button_clicked
- *	Action on remove button, remove the last @NumPartEditor
+ *	Action on remove button, remove the last NumPartEditor
 */
 void SelectAutonumW::on_remove_button_clicked() {
 	//remove if @num_part_list contains more than one item
@@ -170,7 +172,8 @@ QComboBox *SelectAutonumW::contextComboBox() const
 
 /**
 	@brief SelectAutonumW::on_buttonBox_clicked
-	Action on @buttonBox clicked
+	Action on button clicked
+	@param button
 */
 void SelectAutonumW::on_buttonBox_clicked(QAbstractButton *button) {
 	//transform button to int

sources/dataBase/ui/summaryquerywidget.cpp

@@ -82,7 +82,7 @@ QString SummaryQueryWidget::queryStr() const
 /**
 	@brief SummaryQueryWidget::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 SummaryQueryWidget::setQuery(const QString &query)

sources/editor/terminaleditor.cpp

@@ -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 editor :
-	@param term La borne a editer
+	L'editeur d'element concerne
-	@param parent QWidget parent de ce widget
+	@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;

sources/editor/terminaleditor.h

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

sources/editor/ui/texteditor.cpp

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

sources/factory/propertieseditorfactory.cpp

@@ -38,7 +38,9 @@
 /**
 	@brief PropertiesEditorFactory::propertiesEditor
 	@param model : the model to be edited
-	@param editor : if the properties editor to be created is the same class as @editor, the this function set @item as edited item of @editor and return editor
+	@param editor :
+	if the properties editor to be created is the same class as editor,
+	the this function set item as edited item of editor and return editor
 	@param parent : parent widget of the returned editor
 	@return an editor or nullptr
 */
@@ -62,11 +64,13 @@ PropertiesEditorWidget *PropertiesEditorFactory::propertiesEditor(QAbstractItemM
 }
 
 /**
-* @brief propertiesEditor
+	@brief propertiesEditor
-* @param items : The items to be edited
+	@param items : The items to be edited
-* @param editor : If the properties editor to be created is the same class as @editor, then this function set @item as edited item of @editor and return editor
+	@param editor :
-* @param parent : parent widget of the returned editor
+	If the properties editor to be created is the same class as editor,
-* @return : an editor or nullptr;
+	then this function set item as edited item of editor and return editor
+	@param parent : parent widget of the returned editor
+	@return : an editor or nullptr;
 */
 PropertiesEditorWidget *PropertiesEditorFactory::propertiesEditor(QList<QGraphicsItem *> items, PropertiesEditorWidget *editor, QWidget *parent)
 {

sources/properties/xrefproperties.cpp

@@ -91,7 +91,8 @@ void XRefProperties::fromSettings(const QSettings &settings, const QString prefi
 /**
 	@brief XRefProperties::toXml
 	Save to xml
-	@param xml_element: QDomElement to use for saving
+	@param xml_document : QDomElement to use for saving
+	@return QDomElement
 */
 QDomElement XRefProperties::toXml(QDomDocument &xml_document) const {
 

sources/qetgraphicsitem/terminal.cpp

@@ -198,7 +198,8 @@ void Terminal::setNumber(QString number) {
 
 /**
 	@brief Terminal::setName
-	@param name
+	@param name : QString
+	@param hiddenName : bool
 */
 void Terminal::setName(QString name, bool hiddenName) {
 	name_terminal_ = std::move(name);

sources/qetgraphicsitem/terminalelement.cpp

@@ -22,7 +22,6 @@
 	Default constructor
 	@param location location of xml definition
 	@param qgi parent QGraphicItem
-	@param s parent diagram
 	@param state int used to know if the creation of element have error
 */
 TerminalElement::TerminalElement(const ElementsLocation &location,

sources/titleblock/templatecellwidget.cpp

@@ -26,8 +26,10 @@
 #include "qetinformation.h"
 
 /**
+	@brief TitleBlockTemplateCellWidget::TitleBlockTemplateCellWidget
 	Constructor
-	@param parent Parent QWidget
+	@param parent_template : TitleBlockTemplate
+	@param parent : QWidget
 */
 TitleBlockTemplateCellWidget::TitleBlockTemplateCellWidget(TitleBlockTemplate *parent_template, QWidget *parent) :
 	QWidget(parent),

sources/titleblock/templatelocation.cpp

@@ -56,8 +56,8 @@ TitleBlockTemplatesCollection *TitleBlockTemplateLocation::parentCollection() co
 }
 
 /**
-	@param project The new parent collection of the template, or 0 if none
+	@brief TitleBlockTemplateLocation::setParentCollection
-	applies.
+	@param collection : TitleBlockTemplatesCollection
 */
 void TitleBlockTemplateLocation::setParentCollection(TitleBlockTemplatesCollection *collection) {
 	collection_ = collection;

sources/titleblock/templatelocationchooser.cpp

@@ -21,9 +21,10 @@
 #include "templatescollection.h"
 
 /**
+	@brief TitleBlockTemplateLocationChooser::TitleBlockTemplateLocationChooser
 	Constructor
-	@param location Initial location displayed by the widget
+	@param location : Initial location displayed by the widget
-	@param widget Parent QWidget
+	@param parent : Parent QWidget
 */
 TitleBlockTemplateLocationChooser::TitleBlockTemplateLocationChooser(
 	const TitleBlockTemplateLocation &location,
@@ -99,8 +100,11 @@ void TitleBlockTemplateLocationChooser::init() {
 }
 
 /**
-	@param coll A Title block templates collection which we want to know the index within the combo box of this dialog.
+	@brief TitleBlockTemplateLocationChooser::indexForCollection
-	@return -1 if the collection is unknown to this dialog, or the index of \a coll
+	@param coll : A Title block templates collection
+	which we want to know the index within the combo box of this dialog.
+	@return -1 if the collection is unknown to this dialog,
+	or the index of \a coll
 */
 int TitleBlockTemplateLocationChooser::indexForCollection(TitleBlockTemplatesCollection *coll) const {
 	QList<int> indexes = collections_index_.keys(coll);

sources/titleblock/templatelocationsaver.cpp

@@ -21,9 +21,10 @@
 #include "templatescollection.h"
 
 /**
+	@brief TitleBlockTemplateLocationSaver::TitleBlockTemplateLocationSaver
 	Constructor
-	@param location Initial location displayed by the widget
+	@param location
-	@param widget Parent QWidget
+	@param parent : QWidget
 */
 TitleBlockTemplateLocationSaver::TitleBlockTemplateLocationSaver(
 	const TitleBlockTemplateLocation &location,

sources/titleblock/templatescollection.cpp

@@ -44,7 +44,8 @@ QString TitleBlockTemplatesCollection::title() const {
 }
 
 /**
-	@oaram title New title for this collection
+	@brief TitleBlockTemplatesCollection::setTitle
+	@param title : New title for this collection
 */
 void TitleBlockTemplatesCollection::setTitle(const QString &title) {
 	title_ = title;

sources/titleblock/templateview.cpp

@@ -52,7 +52,8 @@ TitleBlockTemplateView::TitleBlockTemplateView(QWidget *parent) :
 }
 
 /**
-	Constructor
+	@brief TitleBlockTemplateView::TitleBlockTemplateView
+	@param scene
 	@param parent Parent QWidget.
 */
 TitleBlockTemplateView::TitleBlockTemplateView(QGraphicsScene *scene, QWidget *parent) :
@@ -444,9 +445,13 @@ TitleBlockTemplateCellsSet TitleBlockTemplateView::cells(const QRectF &rect) con
 }
 
 /**
-	@param can_merge If non-zero, will be changed to reflect whether selected cells may be merged
+	@brief TitleBlockTemplateView::analyzeSelectedCells
-	@param can_merge If non-zero, will be changed to reflect whether selected cells may be splitted
+	@param can_merge :
-	@param count     If non-zero, will be changed to reflect the number of selected cells
+	If non-zero, will be changed to reflect whether selected cells may be merged
+	@param can_split :
+	If non-zero, will be changed to reflect whether selected cells may be splitted
+	@param count :
+	If non-zero, will be changed to reflect the number of selected cells
 */
 void TitleBlockTemplateView::analyzeSelectedCells(bool *can_merge, bool *can_split, int *count) {
 	if (!can_merge && !can_split) return;
@@ -822,8 +827,12 @@ bool TitleBlockTemplateView::event(QEvent *event) {
 }
 
 /**
-	Given a cells list, change their position so the top left one is at row \a x and column \a y.
+	@brief TitleBlockTemplateView::normalizeCells
+	Given a cells list,
+	change their position so the top left one is at row \a x and column \a y.
 	@param cells Cells list
+	@param x : row
+	@param y : column
 */
 void TitleBlockTemplateView::normalizeCells(QList<TitleBlockCell> &cells, int x, int y) const {
 	if (!cells.count()) return;
@@ -1051,7 +1060,8 @@ void TitleBlockTemplateView::removeItem(QGraphicsLayoutItem *item) {
 }
 
 /**
-	@param a list of QGraphicsItem
+	@brief TitleBlockTemplateView::makeCellsSetFromGraphicsItems
+	@param items : a list of QGraphicsItem
 	@return the corresponding TitleBlockTemplateCellsSet
 */
 TitleBlockTemplateCellsSet TitleBlockTemplateView::makeCellsSetFromGraphicsItems(const QList<QGraphicsItem *> &items) const {
@@ -1066,8 +1076,9 @@ TitleBlockTemplateCellsSet TitleBlockTemplateView::makeCellsSetFromGraphicsItems
 	return(set);
 }
 
-/*
+/**
-	@param a text string
+	@brief TitleBlockTemplateView::makePrettyToolTip
+	@param string : a text string
 	@return an HTML string that can be passed to setToolTip()
 */
 QString TitleBlockTemplateView::makePrettyToolTip(const QString &string) {

sources/titleblockcell.cpp

@@ -217,7 +217,8 @@ void TitleBlockCell::loadContentFromXml(const QDomElement &cell_element) {
 }
 
 /**
-	@param xml_element XML element to which cell content will be exported
+	@brief TitleBlockCell::saveContentToXml
+	@param cell_elmt : XML element to which cell content will be exported
 */
 void TitleBlockCell::saveContentToXml(QDomElement &cell_elmt) {
 	cell_elmt.setAttribute("name", value_name);

sources/ui/titleblockpropertieswidget.cpp

@@ -29,6 +29,7 @@
 	default constructor
 	@param titleblock properties to edit
 	@param current_date if true, display the radio button "current date"
+	@param project : QETProject
 	@param parent parent widget
 */
 TitleBlockPropertiesWidget::TitleBlockPropertiesWidget(const TitleBlockProperties &titleblock, bool current_date, QETProject *project, QWidget *parent) :
@@ -46,6 +47,7 @@ TitleBlockPropertiesWidget::TitleBlockPropertiesWidget(const TitleBlockPropertie
 	@param tbt_collection template list
 	@param titleblock properties to edit
 	@param current_date if true, display the radio button "current date"
+	@param project : QETProject
 	@param parent parent widget
 */
 TitleBlockPropertiesWidget::TitleBlockPropertiesWidget(TitleBlockTemplatesCollection *tbt_collection, const TitleBlockProperties &titleblock, bool current_date, QETProject *project, QWidget *parent) :
@@ -65,6 +67,7 @@ TitleBlockPropertiesWidget::TitleBlockPropertiesWidget(TitleBlockTemplatesCollec
 	@param tbt_collection template list
 	@param titleblock properties to edit
 	@param current_date if true, display the radio button "current date"
+	@param project : QETProject
 	@param parent parent widget
 */
 TitleBlockPropertiesWidget::TitleBlockPropertiesWidget(QList<TitleBlockTemplatesCollection *> tbt_collection, const TitleBlockProperties &titleblock, bool current_date, QETProject *project, QWidget *parent) :
@@ -284,7 +287,8 @@ void TitleBlockPropertiesWidget::addCollection(TitleBlockTemplatesCollection *tb
 /**
 	@brief TitleBlockPropertiesWidget::initDialog
 	Init this dialog
-	@param current_date true for display current date radio button
+	@param current_date : true for display current date radio button
+	@param project
 */
 void TitleBlockPropertiesWidget::initDialog(const bool &current_date,  QETProject *project) {
 	m_dcw = new DiagramContextWidget();