diff --git a/sources/ElementsCollection/fileelementcollectionitem.cpp b/sources/ElementsCollection/fileelementcollectionitem.cpp index c4a430192..f3f7f63a0 100644 --- a/sources/ElementsCollection/fileelementcollectionitem.cpp +++ b/sources/ElementsCollection/fileelementcollectionitem.cpp @@ -35,6 +35,8 @@ FileElementCollectionItem::FileElementCollectionItem() Set path has root path for this file item. Use this function only to set the beginning of a file collection. @param path + @param set_data + @param hide_element @return true if path exist. */ bool FileElementCollectionItem::setRootPath(const QString& path, diff --git a/sources/NameList/nameslist.cpp b/sources/NameList/nameslist.cpp index 067307f06..904ea4377 100644 --- a/sources/NameList/nameslist.cpp +++ b/sources/NameList/nameslist.cpp @@ -128,7 +128,7 @@ void NamesList::fromXml(const QDomElement &xml_element, const QHash name from an xml description. - @xml_element must be the parent of a child element tagged "names" + xml_element must be the parent of a child element tagged "names" If a couple lang <-> name already exist, they will overwrited, else they will be appened. @param xml_element : xml element to analyze diff --git a/sources/autoNum/numerotationcontext.cpp b/sources/autoNum/numerotationcontext.cpp index 7751de901..99e980521 100644 --- a/sources/autoNum/numerotationcontext.cpp +++ b/sources/autoNum/numerotationcontext.cpp @@ -41,10 +41,12 @@ void NumerotationContext::clear () { } /** - @brief NumerotationContext::addValue, add a new value on the contexte + @brief NumerotationContext::addValue + add a new value on the contexte @param type the type of value @param value the value itself @param increase the increase number of value + @param initialvalue @return true if value is append */ bool NumerotationContext::addValue(const QString &type, const QVariant &value, const int increase, const int initialvalue) { diff --git a/sources/autoNum/ui/autonumberingdockwidget.cpp b/sources/autoNum/ui/autonumberingdockwidget.cpp index 95cf896da..2979df571 100644 --- a/sources/autoNum/ui/autonumberingdockwidget.cpp +++ b/sources/autoNum/ui/autonumberingdockwidget.cpp @@ -223,7 +223,6 @@ void AutoNumberingDockWidget::conductorAutoNumChanged() { /** @brief AutoNumberingDockWidget::on_m_conductor_cb_activated - @param unused Set new conductor AutoNum */ void AutoNumberingDockWidget::on_m_conductor_cb_activated(int) @@ -254,7 +253,6 @@ void AutoNumberingDockWidget::elementAutoNumChanged() { /** @brief AutoNumberingDockWidget::on_m_element_cb_activated - @param unused Set new element AutoNum */ void AutoNumberingDockWidget::on_m_element_cb_activated(int) @@ -282,7 +280,6 @@ void AutoNumberingDockWidget::folioAutoNumChanged() { /** @brief AutoNumberingDockWidget::on_m_folio_cb_activated - @param unused Set new folio AutoNum */ void AutoNumberingDockWidget::on_m_folio_cb_activated(int) { diff --git a/sources/autoNum/ui/numparteditorw.cpp b/sources/autoNum/ui/numparteditorw.cpp index bc9aa8f24..af144104e 100644 --- a/sources/autoNum/ui/numparteditorw.cpp +++ b/sources/autoNum/ui/numparteditorw.cpp @@ -20,7 +20,10 @@ #include "ui_numparteditorw.h" /** + @brief NumPartEditorW::NumPartEditorW Constructor + @param type + @param parent */ NumPartEditorW::NumPartEditorW(int type, QWidget *parent) : QWidget(parent), @@ -208,7 +211,7 @@ void NumPartEditorW::on_type_cb_activated(int) { /** @brief NumPartEditorW::on_value_field_textChanged - emit changed when @value_field text changed + emit changed when value_field text changed */ void NumPartEditorW::on_value_field_textEdited() { emit changed(); @@ -216,7 +219,7 @@ void NumPartEditorW::on_value_field_textEdited() { /** @brief NumPartEditorW::on_increase_spinBox_valueChanged - emit changed when @increase_spinBox value changed + emit changed when increase_spinBox value changed */ void NumPartEditorW::on_increase_spinBox_valueChanged(int) { if (!ui -> value_field -> text().isEmpty()) emit changed(); @@ -224,9 +227,9 @@ void NumPartEditorW::on_increase_spinBox_valueChanged(int) { /** @brief NumPartEditorW::setType - Set good behavior by type @t - @param t, type used - @param fnum, force the behavior of numeric type + Set good behavior by type t + @param t : type used + @param fnum : force the behavior of numeric type */ void NumPartEditorW::setType(NumPartEditorW::type t, bool fnum) { setCurrentIndex(t); @@ -287,7 +290,7 @@ void NumPartEditorW::setType(NumPartEditorW::type t, bool fnum) { /** @brief NumPartEditorW::setCurrentIndex Set Current Index of type_cb - @param t, type used + @param t : type used */ void NumPartEditorW::setCurrentIndex(NumPartEditorW::type t) { int i=-1; diff --git a/sources/bordertitleblock.cpp b/sources/bordertitleblock.cpp index 6363c176b..e8d58ff30 100644 --- a/sources/bordertitleblock.cpp +++ b/sources/bordertitleblock.cpp @@ -499,7 +499,7 @@ void BorderTitleBlock::updateRectangles() /** @brief BorderTitleBlock::draw Draw the border and the titleblock. - @param painter, QPainter to use for draw this. + @param painter : QPainter to use for draw this. */ void BorderTitleBlock::draw(QPainter *painter) { diff --git a/sources/configdialog.cpp b/sources/configdialog.cpp index 3981734b7..fe5c5e788 100644 --- a/sources/configdialog.cpp +++ b/sources/configdialog.cpp @@ -138,7 +138,7 @@ void ConfigDialog::addPage(ConfigPage *page) { /** @brief ConfigDialog::setCurrentPage - Set the current index to @index + Set the current index to index @param index */ void ConfigDialog::setCurrentPage(const int index) { diff --git a/sources/dataBase/projectdatabase.cpp b/sources/dataBase/projectdatabase.cpp index 9313a6e43..3c8d16be9 100644 --- a/sources/dataBase/projectdatabase.cpp +++ b/sources/dataBase/projectdatabase.cpp @@ -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 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) { diff --git a/sources/dataBase/projectdatabase.h b/sources/dataBase/projectdatabase.h index d98d44eff..09f86e7fb 100644 --- a/sources/dataBase/projectdatabase.h +++ b/sources/dataBase/projectdatabase.h @@ -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. */ diff --git a/sources/dataBase/ui/elementquerywidget.cpp b/sources/dataBase/ui/elementquerywidget.cpp index 4c08803c5..0e56f12d7 100644 --- a/sources/dataBase/ui/elementquerywidget.cpp +++ b/sources/dataBase/ui/elementquerywidget.cpp @@ -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) { diff --git a/sources/diagram.cpp b/sources/diagram.cpp index e32f2335e..371cd9227 100644 --- a/sources/diagram.cpp +++ b/sources/diagram.cpp @@ -319,7 +319,7 @@ void Diagram::wheelEvent(QGraphicsSceneWheelEvent *event) @brief Diagram::keyPressEvent This event is managed by diagram event interface if any. Else move selected elements - @param e + @param event */ void Diagram::keyPressEvent(QKeyEvent *event) { @@ -567,7 +567,7 @@ QString Diagram::conductorsAutonumName() const { /** @brief Diagram::setConductorsAutonumName - @param name, name of autonum to use. + @param name : name of autonum to use. */ void Diagram::setConductorsAutonumName(const QString &name) { m_conductors_autonum_name= name; @@ -971,9 +971,11 @@ QDomDocument Diagram::toXml(bool whole_content) { /** @brief Diagram::folioSequentialsToXml Add folio sequential to QDomElement - @param domElement to add attributes @param hash to retrieve content with content - @param sequential type + @param domElement to add attributes + @param seq_type type + @param type + @param doc */ void Diagram::folioSequentialsToXml(QHash *hash, @@ -1477,13 +1479,14 @@ bool Diagram::fromXml(QDomElement &document, } /** - * @brief Diagram::folioSequentialsFromXml - * Load folio sequential from QDomElement - * @param root containing all folio sequentials - * @param hash to be loaded with content - * @param folioSeq type - * @param seq type - * @param type of sequential + @brief Diagram::folioSequentialsFromXml + Load folio sequential from QDomElement + @param root containing all folio sequentials + @param hash : to be loaded with content + @param folioSeq type + @param seq type + @param type of sequential + @param autonumFolioSeqType */ void Diagram::folioSequentialsFromXml(const QDomElement &root, QHash *hash, @@ -1750,11 +1752,10 @@ void Diagram::insertFolioSeqHash(QHash *hash, @@ -1777,7 +1778,8 @@ void Diagram::loadFolioSeqHash(QHash DiagramContent::items(int filter) const { @@ -395,7 +396,7 @@ QList DiagramContent::items(int filter) const /** @brief DiagramContent::count @param filter - @return The number of items, according to @filter + @return The number of items, according to filter */ int DiagramContent::count(int filter) const { @@ -430,7 +431,8 @@ int DiagramContent::count(int filter) const /** @brief DiagramContent::sentence @param filter - @return A string that describe the items of the diagram content according to @filter. + @return A string that describe the items of the diagram + content according to filter. Exemple : X elements, Y conductors etc.... */ QString DiagramContent::sentence(int filter) const diff --git a/sources/diagramcontext.cpp b/sources/diagramcontext.cpp index 21d2a7fe8..a18e7485d 100644 --- a/sources/diagramcontext.cpp +++ b/sources/diagramcontext.cpp @@ -22,10 +22,10 @@ /** @brief DiagramContext::add - Add all value of @other to this. + Add all value of other to this. If a key already exist, the value is replaced. If a key doesn't exist, she will be added. - All other keys of this context, which are not present in @other, stay unchanged. + All other keys of this context, which are not present in other, stay unchanged. @param other */ void DiagramContext::add(DiagramContext other) @@ -164,7 +164,8 @@ void DiagramContext::fromXml(const QDomElement &e, const QString &tag_name) { /** @brief DiagramContext::fromXml - Read this context properties from the @dom_element, looking for tags named @tag_name + Read this context properties from the dom_element, + looking for tags named tag_name @param dom_element : dom element to parse @param tag_name : tag name to find, by default "property" */ diff --git a/sources/diagramprintdialog.cpp b/sources/diagramprintdialog.cpp index 9cfa76118..7d410bccb 100644 --- a/sources/diagramprintdialog.cpp +++ b/sources/diagramprintdialog.cpp @@ -83,9 +83,9 @@ QString DiagramPrintDialog::docName() const { } /** - @param diagram Diagram to be printed - @param include_titleblock (Optional, defaults to true) Whether the diagram - titleblock should be printed. + @brief DiagramPrintDialog::diagramRect + @param diagram : Diagram to be printed + @param options : @return the rectangle to be printed */ QRect DiagramPrintDialog::diagramRect(Diagram *diagram, const ExportProperties &options) const { diff --git a/sources/diagramprintdialog.h b/sources/diagramprintdialog.h index aa3b61537..e9b1dcee9 100644 --- a/sources/diagramprintdialog.h +++ b/sources/diagramprintdialog.h @@ -26,8 +26,9 @@ class QPrinter; /** - This class implements both the dialog allowing users to configure the printing - of a project file and the printing itself. + @brief The DiagramPrintDialog class + This class implements both the dialog allowing users to configure + the printing of a project file and the printing itself. */ class DiagramPrintDialog : public QWidget { diff --git a/sources/diagramview.cpp b/sources/diagramview.cpp index 34a18c771..1e187a061 100644 --- a/sources/diagramview.cpp +++ b/sources/diagramview.cpp @@ -178,8 +178,9 @@ void DiagramView::dropEvent(QDropEvent *e) { } /** + @brief DiagramView::handleElementDrop Handle the drop of an element. - @param e the QDropEvent describing the current drag'n drop + @param event the QDropEvent describing the current drag'n drop */ void DiagramView::handleElementDrop(QDropEvent *event) { @@ -573,8 +574,9 @@ bool DiagramView::gestures() const } /** + @brief DiagramView::wheelEvent Manage wheel event of mouse - @param e QWheelEvent + @param event QWheelEvent */ void DiagramView::wheelEvent(QWheelEvent *event) { @@ -1001,7 +1003,7 @@ void DiagramView::resetConductors() { -At first activation (QEvent::WindowActivate or QEvent::Show) we zoomFit. -Convert event interpreted to mouse event to gesture event if needed. -send Shortcut to view (by default send to QMenu /QAction) - @param e the event. + @param e : the event. @return */ bool DiagramView::event(QEvent *e) { diff --git a/sources/editor/UndoCommand/pastepartscommand.cpp b/sources/editor/UndoCommand/pastepartscommand.cpp index 3b53ec7f1..fe9ae060e 100644 --- a/sources/editor/UndoCommand/pastepartscommand.cpp +++ b/sources/editor/UndoCommand/pastepartscommand.cpp @@ -24,9 +24,9 @@ @param view : view where this command work @param content_to_paste : content to paste @param parent : parent undo command - * - Note : all terminal stored in @content_to_paste get a new uuid in the constructor of this class to avoid have - several terminal of an element with the same uuid. + @note all terminal stored in content_to_paste get a new uuid + in the constructor of this class to avoid have several terminal + of an element with the same uuid. */ PastePartsCommand::PastePartsCommand(ElementView *view, const ElementContent &content_to_paste, QUndoCommand *parent) : ElementEditionCommand(view ? view -> scene() : nullptr, view, parent) diff --git a/sources/editor/editorcommands.cpp b/sources/editor/editorcommands.cpp index 73e3453e7..ae5029be2 100644 --- a/sources/editor/editorcommands.cpp +++ b/sources/editor/editorcommands.cpp @@ -18,8 +18,12 @@ #include "editorcommands.h" /** - Constructs an ElementEditionCommand, thus embedding the provided \a scene and \a view. - @param parent Parent command + @brief ElementEditionCommand::ElementEditionCommand + Constructs an ElementEditionCommand, + thus embedding the provided \a scene and \a view. + @param scene + @param view + @param parent : Parent command */ ElementEditionCommand::ElementEditionCommand(ElementScene *scene, ElementView *view, QUndoCommand *parent): QUndoCommand(parent), @@ -29,9 +33,13 @@ ElementEditionCommand::ElementEditionCommand(ElementScene *scene, ElementView *v } /** - Constructs an ElementEditionCommand, thus embedding the provided \a scene and \a view. - @param text Text describing the effect of the command - @param parent Parent command + @brief ElementEditionCommand::ElementEditionCommand + Constructs an ElementEditionCommand, + thus embedding the provided \a scene and \a view. + @param text : Text describing the effect of the command + @param scene + @param view + @param parent : Parent command */ ElementEditionCommand::ElementEditionCommand(const QString &text, ElementScene *scene, ElementView *view, QUndoCommand *parent): QUndoCommand(text, parent), @@ -529,10 +537,11 @@ void ScalePartsCommand::adjustText() { /** @brief ChangePropertiesCommand::ChangePropertiesCommand Change the properties of the drawed element - @param scene: scene to belong the property - @param type: new type of element. - @param context: new info about type. - @param parent: parent undo + @param scene : scene to belong the property + @param type : new type of element. + @param info + @param elmt_info : new info about type. + @param parent : parent undo */ ChangePropertiesCommand::ChangePropertiesCommand(ElementScene *scene, const QString& type, const DiagramContext& info, const DiagramContext& elmt_info, QUndoCommand *parent) : ElementEditionCommand(scene, nullptr, parent) diff --git a/sources/editor/elementprimitivedecorator.cpp b/sources/editor/elementprimitivedecorator.cpp index f7c90baed..768d1d769 100644 --- a/sources/editor/elementprimitivedecorator.cpp +++ b/sources/editor/elementprimitivedecorator.cpp @@ -73,9 +73,12 @@ QRectF ElementPrimitiveDecorator::boundingRect() const } /** - Paint the contents of an item in local coordinates, using \a painter, with - respect to \a option and - @param option The option parameter provides style options for the item, such + @brief ElementPrimitiveDecorator::paint + Paint the contents of an item in local coordinates, using \a painter, + with respect to \a option and + @param painter : + @param option : + The option parameter provides style options for the item, such as its state, exposed area and its level-of-detail hints. @param The widget argument is optional. If provided, it points to the widget that is being painted on; otherwise, it is 0. For cached painting, @@ -244,7 +247,9 @@ void ElementPrimitiveDecorator::mouseReleaseEvent(QGraphicsSceneMouseEvent *even } /** - @reimp QGraphicsItem::keyPressEvent + @brief ElementPrimitiveDecorator::keyPressEvent + @param e + @see QGraphicsItem::keyPressEvent */ void ElementPrimitiveDecorator::keyPressEvent(QKeyEvent *e) { @@ -295,7 +300,9 @@ void ElementPrimitiveDecorator::keyPressEvent(QKeyEvent *e) } /** - @reimp QGraphicsItem::keyReleaseEvent + @brief ElementPrimitiveDecorator::keyReleaseEvent + @param e + @see QGraphicsItem::keyReleaseEvent */ void ElementPrimitiveDecorator::keyReleaseEvent(QKeyEvent *e) { // detecte le relachement d'une touche de direction ( = deplacement de parties) diff --git a/sources/editor/elementscene.cpp b/sources/editor/elementscene.cpp index 9681bd487..5ad35757e 100644 --- a/sources/editor/elementscene.cpp +++ b/sources/editor/elementscene.cpp @@ -312,7 +312,7 @@ void ElementScene::drawForeground(QPainter *p, const QRectF &rect) { /** @brief ElementScene::setEventInterface Set a new event interface - @param interface + @param event_interface */ void ElementScene::setEventInterface(ESEventInterface *event_interface) { diff --git a/sources/editor/elementview.cpp b/sources/editor/elementview.cpp index edae5ae29..ef04c4dc9 100644 --- a/sources/editor/elementview.cpp +++ b/sources/editor/elementview.cpp @@ -539,10 +539,13 @@ void ElementView::drawBackground(QPainter *p, const QRectF &r) { } /** + @brief ElementView::applyMovement Applique le decalage offset dans le sens movement au rectangle start - @param start rectangle a decaler - @param movement Orientation du decalage a appliquer - @param offset Decalage a appliquer + @param start : + rectangle a decaler + @param offset : + Decalage a appliquer + @return */ QRectF ElementView::applyMovement(const QRectF &start, const QPointF &offset) { // calcule le decalage a appliquer a partir de l'offset diff --git a/sources/editor/graphicspart/customelementgraphicpart.cpp b/sources/editor/graphicspart/customelementgraphicpart.cpp index 193a7bd5b..4c656bf1a 100644 --- a/sources/editor/graphicspart/customelementgraphicpart.cpp +++ b/sources/editor/graphicspart/customelementgraphicpart.cpp @@ -25,6 +25,7 @@ By default, item is selectable, send geometry change (Qt > 4.6), accept mouse left button and accept hover event @param editor QETElement editor that belong this. + @param parent */ CustomElementGraphicPart::CustomElementGraphicPart(QETElementEditor *editor, QGraphicsItem *parent) : QGraphicsObject (parent), diff --git a/sources/editor/graphicspart/partdynamictextfield.cpp b/sources/editor/graphicspart/partdynamictextfield.cpp index 285cddbbe..03f3033cb 100644 --- a/sources/editor/graphicspart/partdynamictextfield.cpp +++ b/sources/editor/graphicspart/partdynamictextfield.cpp @@ -87,7 +87,7 @@ void PartDynamicTextField::handleUserTransformation( /** @brief PartDynamicTextField::toXml - @param document + @param dom_doc @return */ const QDomElement PartDynamicTextField::toXml(QDomDocument &dom_doc) const { @@ -150,7 +150,7 @@ const QDomElement PartDynamicTextField::toXml(QDomDocument &dom_doc) const { /** @brief PartDynamicTextField::fromXml - @param element + @param dom_elmt */ void PartDynamicTextField::fromXml(const QDomElement &dom_elmt) { if (dom_elmt.tagName() != xmlName()) { @@ -323,7 +323,7 @@ QString PartDynamicTextField::infoName() const{ /** @brief PartDynamicTextField::setCompositeText - Set the composite text of this text item to @text + Set the composite text of this text item to text @param text */ void PartDynamicTextField::setCompositeText(const QString &text) { diff --git a/sources/editor/graphicspart/partpolygon.cpp b/sources/editor/graphicspart/partpolygon.cpp index 86c487532..794b2fbd9 100644 --- a/sources/editor/graphicspart/partpolygon.cpp +++ b/sources/editor/graphicspart/partpolygon.cpp @@ -224,7 +224,7 @@ void PartPolygon::addPoint(const QPointF &point) /** @brief PartPolygon::setLastPoint - Set the last point of polygon to @point + Set the last point of polygon to point @param point */ void PartPolygon::setLastPoint(const QPointF &point) @@ -259,7 +259,7 @@ void PartPolygon::setClosed(bool close) /** @brief PartPolygon::setHandlerColor - Set the handler at pos @pos (in polygon coordinate) to color @color. + Set the handler at pos pos (in polygon coordinate) to color color. @param pos @param color */ diff --git a/sources/editor/graphicspart/partterminal.cpp b/sources/editor/graphicspart/partterminal.cpp index 90bd6ec7b..ed256e4fb 100644 --- a/sources/editor/graphicspart/partterminal.cpp +++ b/sources/editor/graphicspart/partterminal.cpp @@ -19,10 +19,11 @@ #include "terminal.h" /** - Constructeur - @param editor L'editeur d'element concerne - @param parent Le QGraphicsItem parent de cette borne - @param scene La scene sur laquelle figure cette borne + @brief PartTerminal::PartTerminal + @param editor : + L'editeur d'element concerne + @param parent : + Le QGraphicsItem parent de cette borne */ PartTerminal::PartTerminal(QETElementEditor *editor, QGraphicsItem *parent) : CustomElementGraphicPart(editor, parent) diff --git a/sources/editor/graphicspart/parttext.cpp b/sources/editor/graphicspart/parttext.cpp index 5736843ea..bd1725168 100644 --- a/sources/editor/graphicspart/parttext.cpp +++ b/sources/editor/graphicspart/parttext.cpp @@ -116,9 +116,10 @@ QPointF PartText::margin() const { } /** - @reimp QGraphicsItem::focusInEvent(QFocusEvent *) - @param e The QFocusEvent object describing the focus gain. + @brief PartText::focusInEvent + @param e : The QFocusEvent object describing the focus gain. Start text edition when the item gains focus. + @see QGraphicsItem::focusInEvent(QFocusEvent *) */ void PartText::focusInEvent(QFocusEvent *e) { startEdition(); @@ -126,9 +127,10 @@ void PartText::focusInEvent(QFocusEvent *e) { } /** - @reimp QGraphicsItem::focusOutEvent(QFocusEvent *) - @param e The QFocusEvent object describing the focus loss. + @brief PartText::focusOutEvent + @param e : The QFocusEvent object describing the focus loss. End text edition when the item loses focus. + @see QGraphicsItem::focusOutEvent(QFocusEvent *) */ void PartText::focusOutEvent(QFocusEvent *e) { QGraphicsTextItem::focusOutEvent(e); @@ -136,9 +138,11 @@ void PartText::focusOutEvent(QFocusEvent *e) { } /** - @reimp QGraphicsTextItem::keyPressEvent() - Used to handle the escape key when the event is delivered to the field, not - to the decorator. + @brief PartText::keyPressEvent + Used to handle the escape key when the event is delivered to the field, + not to the decorator. + @param event + @see QGraphicsTextItem::keyPressEvent() */ void PartText::keyPressEvent(QKeyEvent *event) { if (event -> key() == Qt::Key_Escape) { diff --git a/sources/editor/ui/dynamictextfieldeditor.cpp b/sources/editor/ui/dynamictextfieldeditor.cpp index 018d58455..151545d70 100644 --- a/sources/editor/ui/dynamictextfieldeditor.cpp +++ b/sources/editor/ui/dynamictextfieldeditor.cpp @@ -54,9 +54,9 @@ DynamicTextFieldEditor::~DynamicTextFieldEditor() { /** @brief DynamicTextFieldEditor::setPart - Set @part as current edited part of this widget. + Set part as current edited part of this widget. @param part - @return true if @part can be edited by this widget + @return true if part can be edited by this widget */ bool DynamicTextFieldEditor::setPart(CustomElementPart *part) { disconnectConnections(); diff --git a/sources/elementprovider.cpp b/sources/elementprovider.cpp index 2653fac4e..7928a2b8a 100644 --- a/sources/elementprovider.cpp +++ b/sources/elementprovider.cpp @@ -43,11 +43,12 @@ ElementProvider::ElementProvider(Diagram *diag) { /** @brief ElementProvider::FreeElement - Search and return the asked element corresponding with the given filter - All returned element are free, ie element aren't connected with another element + Search and return the asked element corresponding with the given filter + All returned element are free, + ie element aren't connected with another element @param filter the filter for search element - (You can find all filter with the #define in Element.h) + (You can find all filter with the define in Element.h) @return */ QList ElementProvider::freeElement(const int filter) const{ @@ -69,7 +70,7 @@ QList ElementProvider::freeElement(const int filter) const{ /** @brief ElementProvider::fromUuids @param uuid_list list of uuid must be found - @return all elements with uuid corresponding to uuid in @uuid_list + @return all elements with uuid corresponding to uuid in uuid_list */ QList ElementProvider::fromUuids(QList uuid_list) const { QList found_element; @@ -90,7 +91,7 @@ QList ElementProvider::fromUuids(QList uuid_list) const { Search and return the asked element corresponding with the given filter @param filter the filter for search element - (You can find all filter with the #define in Element.h) + (You can find all filter with the define in Element.h) */ QList ElementProvider::find(const int filter) const { QList elmt_; @@ -112,7 +113,8 @@ QList ElementProvider::find(const int filter) const { @brief ElementProvider::table @param table @param model - @return All tables wich display the derivated class of @model (if set) and not already in all the chain of next/previous table of @table (if set) + @return All tables wich display the derivated class of model (if set) + and not already in all the chain of next/previous table of table (if set) If table and model are nullptr, return every tables */ QVector ElementProvider::table(QetGraphicsTableItem *table, QAbstractItemModel *model) @@ -160,7 +162,7 @@ QVector ElementProvider::table(QetGraphicsTableItem *tab /** @brief ElementProvider::tableFromUuid @param uuid - @return the table with uuid @uuid or nullptr if not found + @return the table with uuid uuid or nullptr if not found */ QetGraphicsTableItem *ElementProvider::tableFromUuid(const QUuid &uuid) { diff --git a/sources/elementscollectioncache.cpp b/sources/elementscollectioncache.cpp index 3c8189dfc..f94686b11 100644 --- a/sources/elementscollectioncache.cpp +++ b/sources/elementscollectioncache.cpp @@ -205,7 +205,7 @@ QPixmap ElementsCollectionCache::pixmap() const { Retrieve the data by building the full CustomElement object matching the given location, without using the cache. Data are then available through pixmap() and name() methods. - @param Location Location of a given Element. + @param location Location of a given Element. @return True if the retrieval succeeded, false otherwise. */ bool ElementsCollectionCache::fetchData(const ElementsLocation &location) { diff --git a/sources/elementspanel.cpp b/sources/elementspanel.cpp index f855ccc08..9256d5f84 100644 --- a/sources/elementspanel.cpp +++ b/sources/elementspanel.cpp @@ -118,10 +118,15 @@ void ElementsPanel::panelContentChange() { } /** + @brief ElementsPanel::addProject Methode permettant d'ajouter un projet au panel d'elements. - @param qtwi_parent QTreeWidgetItem parent sous lequel sera insere le projet - @param project Projet a inserer dans le panel d'elements - @return Le QTreeWidgetItem insere le plus haut + @param project : + project Projet a inserer dans le panel d'elements + @param parent_item : Q_UNUSED + QTreeWidgetItem parent sous lequel sera insere le projet + @param options : Q_UNUSED + @return + Le QTreeWidgetItem insere le plus haut */ QTreeWidgetItem *ElementsPanel::addProject(QETProject *project, QTreeWidgetItem *parent_item, PanelOptions options) { @@ -188,7 +193,8 @@ bool ElementsPanel::matchesFilter(const QTreeWidgetItem *item, const QString& fi /** @brief ElementsPanel::reload Reload the elements tree - @param reload_collections true for read all collections since their sources (files, projects ...) + @param reload_collections : + true for read all collections since their sources (files, projects ...) */ void ElementsPanel::reload(bool reload_collections) { Q_UNUSED(reload_collections); @@ -244,8 +250,9 @@ void ElementsPanel::slot_doubleClick(QTreeWidgetItem *qtwi, int) { } /** - @param qtwi a QTreeWidgetItem - @return the directory path of the object represented by \a qtwi + @brief ElementsPanel::dirPathForItem + @param item : a QTreeWidgetItem + @return the directory path of the object represented by \a item */ QString ElementsPanel::dirPathForItem(QTreeWidgetItem *item) { QString file_path = filePathForItem(item); @@ -262,8 +269,9 @@ QString ElementsPanel::dirPathForItem(QTreeWidgetItem *item) { } /** - @param qtwi a QTreeWidgetItem - @return the filepath of the object represented by \a qtwi + @brief ElementsPanel::filePathForItem + @param item : a QTreeWidgetItem + @return the filepath of the object represented by \a item */ QString ElementsPanel::filePathForItem(QTreeWidgetItem *item) { if (!item) return(QString()); diff --git a/sources/elementtextpattern.cpp b/sources/elementtextpattern.cpp index 22d2da5ae..02330ce14 100644 --- a/sources/elementtextpattern.cpp +++ b/sources/elementtextpattern.cpp @@ -161,8 +161,10 @@ ImportElementTextPattern::ImportElementTextPattern(Element *elmt): /** @brief ImportElementTextPattern::getName Open a dialog to let user select a conf + @param list @param ok - @return + @param erase + @return */ QString ImportElementTextPattern::getName(const QStringList& list, bool *ok, bool *erase) const { diff --git a/sources/exportdialog.cpp b/sources/exportdialog.cpp index 2c98645b2..9939cd543 100644 --- a/sources/exportdialog.cpp +++ b/sources/exportdialog.cpp @@ -397,7 +397,7 @@ void ExportDialog::generateSvg(Diagram *diagram, int width, int height, bool kee @param width Largeur de l'export DXF @param height Hauteur de l'export DXF @param keep_aspect_ratio True pour conserver le ratio, false sinon - @param io_device Peripherique de sortie pour le code DXF (souvent : un fichier) + @param file_path */ void ExportDialog::generateDxf(Diagram *diagram, int width, diff --git a/sources/factory/elementpicturefactory.cpp b/sources/factory/elementpicturefactory.cpp index 2529cbe96..b63774d90 100644 --- a/sources/factory/elementpicturefactory.cpp +++ b/sources/factory/elementpicturefactory.cpp @@ -70,7 +70,7 @@ void ElementPictureFactory::getPictures(const ElementsLocation &location, QPictu /** @brief ElementPictureFactory::pixmap @param location - @return the pixmap of the element at @location + @return the pixmap of the element at location Note pixmap can be null */ QPixmap ElementPictureFactory::pixmap(const ElementsLocation &location) @@ -115,7 +115,7 @@ QPixmap ElementPictureFactory::pixmap(const ElementsLocation &location) /** @brief ElementPictureFactory::getPrimitives @param location - @return The primtive used to draw the element at @location + @return The primtive used to draw the element at location */ ElementPictureFactory::primitives ElementPictureFactory::getPrimitives(const ElementsLocation &location) { @@ -137,8 +137,10 @@ ElementPictureFactory::~ElementPictureFactory() { @param location @param picture @param low_picture - if @picture and/or @low_picture are not null this function draw on it and don't store it. - if null, this function create a QPicture for normal and low zoom, draw on it and store it in m_pictures_H and m_low_pictures_H + if picture and/or low_picture are not null + this function draw on it and don't store it. + if null, this function create a QPicture for normal and low zoom, + draw on it and store it in m_pictures_H and m_low_pictures_H @return */ bool ElementPictureFactory::build(const ElementsLocation &location, QPicture *picture, QPicture *low_picture) diff --git a/sources/factory/ui/addtabledialog.cpp b/sources/factory/ui/addtabledialog.cpp index b8296540f..4023add76 100644 --- a/sources/factory/ui/addtabledialog.cpp +++ b/sources/factory/ui/addtabledialog.cpp @@ -26,7 +26,7 @@ /** @brief AddTableDialog::AddTableDialog @param content_widget : the widget to display in the "content" tab. - This dialog take ownership of @content_widget. + This dialog take ownership of content_widget. @param parent : parent widget. */ AddTableDialog::AddTableDialog(QWidget *content_widget, QWidget *parent) : diff --git a/sources/nomenclature.cpp b/sources/nomenclature.cpp index 761d9aece..183464fcf 100644 --- a/sources/nomenclature.cpp +++ b/sources/nomenclature.cpp @@ -24,8 +24,10 @@ #define PR(x) qDebug() << #x " = " << x; /** - Constructor - @param an project (QETProject) of QET file + @brief nomenclature::nomenclature + Constructor + @param project : an project (QETProject) of QET file + @param parent */ nomenclature::nomenclature(QETProject *project, QWidget *parent): m_project(project) diff --git a/sources/projectconfigpages.cpp b/sources/projectconfigpages.cpp index 77a3cc86a..7b7bcbb3a 100644 --- a/sources/projectconfigpages.cpp +++ b/sources/projectconfigpages.cpp @@ -57,8 +57,12 @@ QETProject *ProjectConfigPage::project() const { } /** + @brief ProjectConfigPage::setProject Set \a new_project as the project being edited by this page. - @param read_values True to read values from the project into widgets before setting them read only accordingly, false otherwise. Defaults to true. + @param new_project : True to read values from the project + into widgets before setting them read only accordingly, + false otherwise. Defaults to true. + @param read_values @return the former project */ QETProject *ProjectConfigPage::setProject(QETProject *new_project, bool read_values) { @@ -215,8 +219,8 @@ void ProjectMainConfigPage::adjustReadOnly() { /** @brief ProjectAutoNumConfigPage::ProjectAutoNumConfigPage Default constructor - @param project, project to edit - @param parent, parent widget + @param project : project to edit + @param parent : parent widget */ ProjectAutoNumConfigPage::ProjectAutoNumConfigPage (QETProject *project, QWidget *parent) : ProjectConfigPage(project, parent) @@ -342,7 +346,7 @@ void ProjectAutoNumConfigPage::buildConnections() /** @brief ProjectAutoNumConfigPage::updateContext_conductor Display the current selected context for conductor - @param str, key of context stored in project + @param str : key of context stored in project */ void ProjectAutoNumConfigPage::updateContextConductor(const QString& str) { if (str == tr("Nom de la nouvelle numérotation")) m_saw_conductor -> setContext(NumerotationContext()); @@ -352,7 +356,7 @@ void ProjectAutoNumConfigPage::updateContextConductor(const QString& str) { /** @brief ProjectAutoNumConfigPage::updateContext_folio Display the current selected context for folio - @param str, key of context stored in project + @param str : key of context stored in project */ void ProjectAutoNumConfigPage::updateContextFolio(const QString& str) { if (str == tr("Nom de la nouvelle numérotation")) m_saw_folio -> setContext(NumerotationContext()); @@ -362,7 +366,7 @@ void ProjectAutoNumConfigPage::updateContextFolio(const QString& str) { /** @brief ProjectAutoNumConfigPage::updateContextElement Display the current selected context for element - @param str, key of context stored in project + @param str : key of context stored in project */ void ProjectAutoNumConfigPage::updateContextElement(const QString& str) { @@ -617,7 +621,7 @@ void ProjectAutoNumConfigPage::removeContextFolio() { /** @brief ProjectAutoNumConfigPage::changeToTab - @param tab index + @param i index Change to Selected Tab */ void ProjectAutoNumConfigPage::changeToTab(int i) diff --git a/sources/projectconfigpages.h b/sources/projectconfigpages.h index a546fde9d..7016d7b1c 100644 --- a/sources/projectconfigpages.h +++ b/sources/projectconfigpages.h @@ -33,8 +33,9 @@ class FormulaAutonumberingW; class AutoNumberingManagementW; /** - This class, derived from ConfigPage, aims at providing the basic skeleton - for a project configuration page. + @brief The ProjectConfigPage class + This class, derived from ConfigPage, + aims at providing the basic skeleton for a project configuration page. */ class ProjectConfigPage : public ConfigPage { Q_OBJECT diff --git a/sources/projectview.cpp b/sources/projectview.cpp index ef33170a7..3adeea088 100644 --- a/sources/projectview.cpp +++ b/sources/projectview.cpp @@ -882,8 +882,8 @@ void ProjectView::diagramAdded(Diagram *diagram) /** @brief ProjectView::updateTabTitle - Update the title of the tab which display the diagram view @diagram_view. - @param diagram : The diagram view. + Update the title of the tab which display the diagram view. + @param diagram_view : The diagram view. */ void ProjectView::updateTabTitle(DiagramView *diagram_view) { diff --git a/sources/properties/propertiesinterface.h b/sources/properties/propertiesinterface.h index a3cdc27f3..e6c4724ab 100644 --- a/sources/properties/propertiesinterface.h +++ b/sources/properties/propertiesinterface.h @@ -37,6 +37,7 @@ class PropertiesInterface Save properties to setting file. @param settings : is use for prefix a word befor the name of each paramètre + @param QString */ virtual void toSettings (QSettings &settings, const QString = QString()) const =0; @@ -45,6 +46,7 @@ class PropertiesInterface load properties to setting file. @param settings : is use for prefix a word befor the name of each paramètre + @param QString */ virtual void fromSettings (const QSettings &settings, const QString = QString()) =0; diff --git a/sources/qetapp.cpp b/sources/qetapp.cpp index 8bb0a6a55..5c6574402 100644 --- a/sources/qetapp.cpp +++ b/sources/qetapp.cpp @@ -392,8 +392,8 @@ QStringList QETApp::elementInfoKeys() /** @brief ElementsProperties::translatedInfo - Return the translated information key given by @info - If @info don't match, return an empty string + Return the translated information key given by info + If info don't match, return an empty string @param info the key to be translated @return */ @@ -459,8 +459,8 @@ QStringList QETApp::conductorInfoKeys() /** @brief QETApp::conductorTranslatedInfoKey @param key - @return the translated information key given by @key - If @key don't match, return an empty string + @return the translated information key given by key + If key don't match, return an empty string */ QString QETApp::conductorTranslatedInfoKey(const QString &key) { @@ -496,8 +496,8 @@ QStringList QETApp::diagramInfoKeys() /** @brief QETApp::diagramTranslatedInfoKey @param key - @return the translated information key given by @key - If @key don't match, return an empty string + @return the translated information key given by key + If key don't match, return an empty string */ QString QETApp::diagramTranslatedInfoKey(const QString &key) { @@ -1369,7 +1369,7 @@ template QList QETApp::detectWindows() const { } /** - @param T a class inheriting QMainWindow + T a class inheriting QMainWindow @param visible whether detected main windows should be visible */ template void QETApp::setMainWindowsVisible(bool visible) { @@ -2048,7 +2048,7 @@ void QETApp::initSystemTray() { Add a list of \a windows to \a menu. This template function assumes it will be given a QList of pointers to objects inheriting the QMainWindow class. - @param T the class inheriting QMainWindow + T the class inheriting QMainWindow @param menu the menu windows will be added to @param windows A list of top-level windows. */ diff --git a/sources/qetgraphicsitem/ViewItem/projectdbmodel.cpp b/sources/qetgraphicsitem/ViewItem/projectdbmodel.cpp index 29a72cb27..64505a623 100644 --- a/sources/qetgraphicsitem/ViewItem/projectdbmodel.cpp +++ b/sources/qetgraphicsitem/ViewItem/projectdbmodel.cpp @@ -175,7 +175,7 @@ QVariant ProjectDBModel::data(const QModelIndex &index, int role) const /** @brief ProjectDBModel::setQuery - Query the internall bd with @query. + Query the internall bd with query. @param query */ void ProjectDBModel::setQuery(const QString &query) @@ -291,7 +291,7 @@ void ProjectDBModel::fromXml(const QDomElement &element) /** @brief ProjectDBModel::setIdentifier - Set the identifier of this model to @identifier + Set the identifier of this model to identifier @param identifier */ void ProjectDBModel::setIdentifier(const QString &identifier) { diff --git a/sources/qetgraphicsitem/conductor.cpp b/sources/qetgraphicsitem/conductor.cpp index d677a97e6..5cbe69267 100644 --- a/sources/qetgraphicsitem/conductor.cpp +++ b/sources/qetgraphicsitem/conductor.cpp @@ -1495,7 +1495,7 @@ QPainterPath Conductor::path() const /** @brief Conductor::setPropertiesToPotential - @param properties + @param property @param only_text Set propertie to conductor and every conductors in the same potential of conductor. @@ -1532,7 +1532,7 @@ void Conductor::setPropertyToPotential(const ConductorProperties &property, bool /** @brief Conductor::setProperties Set property as current property of conductor - @param properties : properties + @param property : properties */ void Conductor::setProperties(const ConductorProperties &property) { diff --git a/sources/qetgraphicsitem/conductortextitem.cpp b/sources/qetgraphicsitem/conductortextitem.cpp index edf497def..6212888cb 100644 --- a/sources/qetgraphicsitem/conductortextitem.cpp +++ b/sources/qetgraphicsitem/conductortextitem.cpp @@ -23,7 +23,6 @@ /** Constructeur @param parent_conductor Conducteur auquel ce texte est rattache - @param parent_diagram Schema auquel ce texte et son conducteur parent sont rattaches */ ConductorTextItem::ConductorTextItem(Conductor *parent_conductor) : DiagramTextItem(parent_conductor), diff --git a/sources/qetgraphicsitem/diagramtextitem.cpp b/sources/qetgraphicsitem/diagramtextitem.cpp index 3884a7519..fc36afd37 100644 --- a/sources/qetgraphicsitem/diagramtextitem.cpp +++ b/sources/qetgraphicsitem/diagramtextitem.cpp @@ -262,7 +262,7 @@ void DiagramTextItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *o /** @brief DiagramTextItem::focusInEvent - @param e + @param event */ void DiagramTextItem::focusInEvent(QFocusEvent *event) { diff --git a/sources/qetgraphicsitem/element.cpp b/sources/qetgraphicsitem/element.cpp index bbca4ecc3..cc5134465 100644 --- a/sources/qetgraphicsitem/element.cpp +++ b/sources/qetgraphicsitem/element.cpp @@ -164,8 +164,9 @@ void Element::editProperty() &ElementPropertiesWidget::findEditClicked, &dialog, &QDialog::reject); - //Must be windowModal, else when user do a drag and drop - //with the "text" tab of ElementPropertiesWidget, the ui freeze, until user press escape key + //Must be windowModal, else when user do a drag and drop + //with the "text" tab of ElementPropertiesWidget, + //the ui freeze, until user press escape key dialog.setWindowModality(Qt::WindowModal); dialog.exec(); } @@ -194,7 +195,6 @@ void Element::displayHelpLine(bool b) @brief Element::paint @param painter @param options - @param widget */ void Element::paint(QPainter *painter, const QStyleOptionGraphicsItem *options, @@ -1373,7 +1373,7 @@ void Element::addTextGroup(ElementTextItemGroup *group) and set the parent of group to 0. group is not deleted. All texts owned by the group will be reparented to this element - @param name + @param group */ void Element::removeTextGroup(ElementTextItemGroup *group) { @@ -1501,8 +1501,9 @@ QList > Element::AlignedFreeTerminals() const This method can be call once because init the link according to uuid store in a private list, after link, the list is clear, so call another time do nothing. - * - @param prj, ownership project of this element and other element to be linked + + @param prj : + ownership project of this element and other element to be linked */ void Element::initLink(QETProject *prj) { @@ -1645,7 +1646,9 @@ void Element::hoverLeaveEvent(QGraphicsSceneHoverEvent *e) { /** @brief Element::setUpFormula Set up the formula used to create the label of this element - @param : if true set tagged text to code letter (ex K for coil) with condition : + @param code_letter : Q_UNUSED(code_letter) + if true set tagged text to code letter + (ex K for coil) with condition : formula is empty, text tagged "label" is emptty or "_"; */ void Element::setUpFormula(bool code_letter) diff --git a/sources/qetgraphicsitem/element.h b/sources/qetgraphicsitem/element.h index 756a52c72..a825d1094 100644 --- a/sources/qetgraphicsitem/element.h +++ b/sources/qetgraphicsitem/element.h @@ -98,9 +98,10 @@ class Element : public QetGraphicsItem {return m_element_informations;} virtual void setElementInformations(DiagramContext dc); DiagramContext kindInformations() const - {return m_kind_informations;} //@kind_information_ is used to store more information - //about the herited class like contactelement for know - // kind of contact (simple tempo) or number of contact show by the element. + {return m_kind_informations;} + //@kind_information_ is used to store more information + //about the herited class like contactelement for know + // kind of contact (simple tempo) or number of contact show by the element. autonum::sequentialNumbers sequenceStruct() const {return m_autoNum_seq;} diff --git a/sources/qetgraphicsitem/elementtextitemgroup.cpp b/sources/qetgraphicsitem/elementtextitemgroup.cpp index bd6d9092c..dbd59c9e9 100644 --- a/sources/qetgraphicsitem/elementtextitemgroup.cpp +++ b/sources/qetgraphicsitem/elementtextitemgroup.cpp @@ -30,6 +30,12 @@ #include #include +/** + @brief sorting + @param qgia + @param qgib + @return +*/ bool sorting(QGraphicsItem *qgia, QGraphicsItem *qgib) { return qgia->pos().y() < qgib->pos().y(); @@ -37,7 +43,8 @@ bool sorting(QGraphicsItem *qgia, QGraphicsItem *qgib) /** @brief ElementTextItemGroup::ElementTextItemGroup - @param parent + @param name : + @param parent : */ ElementTextItemGroup::ElementTextItemGroup(const QString &name, Element *parent) : QGraphicsItemGroup(parent), @@ -59,7 +66,7 @@ void ElementTextItemGroup::addToGroup(QGraphicsItem *item) { if(item->type() == DynamicElementTextItem::Type) { - //Befor add text to this group we must to set the text at the same rotation of this group + //Befor add text to this group we must to set the text at the same rotation of this group if((item->rotation() != rotation()) && !m_block_alignment_update) item->setRotation(rotation()); diff --git a/sources/qetgraphicsitem/independenttextitem.cpp b/sources/qetgraphicsitem/independenttextitem.cpp index eaed3351e..9b655f888 100644 --- a/sources/qetgraphicsitem/independenttextitem.cpp +++ b/sources/qetgraphicsitem/independenttextitem.cpp @@ -37,9 +37,9 @@ IndependentTextItem::IndependentTextItem() : } /** + @brief IndependentTextItem::IndependentTextItem Constructeur @param text Le texte affiche par le champ de texte - @param parent_diagram Le schema auquel est rattache le champ de texte */ IndependentTextItem::IndependentTextItem(const QString &text) : DiagramTextItem(text, nullptr) diff --git a/sources/qetgraphicsitem/masterelement.cpp b/sources/qetgraphicsitem/masterelement.cpp index 302d092ae..76285c44f 100644 --- a/sources/qetgraphicsitem/masterelement.cpp +++ b/sources/qetgraphicsitem/masterelement.cpp @@ -24,10 +24,9 @@ /** @brief MasterElement::MasterElement 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 + @param location : location of xml definition + @param qgi : parent QGraphicItem + @param state : int used to know if the creation of element have error */ MasterElement::MasterElement(const ElementsLocation &location, QGraphicsItem *qgi, int *state) : Element(location, qgi, state, Element::Master) diff --git a/sources/ui/conductorpropertiesdialog.cpp b/sources/ui/conductorpropertiesdialog.cpp index 7d51f667a..fadc57d95 100644 --- a/sources/ui/conductorpropertiesdialog.cpp +++ b/sources/ui/conductorpropertiesdialog.cpp @@ -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) { diff --git a/sources/ui/conductorpropertieswidget.cpp b/sources/ui/conductorpropertieswidget.cpp index 972380af2..dcaf212e3 100644 --- a/sources/ui/conductorpropertieswidget.cpp +++ b/sources/ui/conductorpropertieswidget.cpp @@ -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), diff --git a/sources/ui/diagrampropertieseditordockwidget.cpp b/sources/ui/diagrampropertieseditordockwidget.cpp index 7e62c4974..aa45faeb8 100644 --- a/sources/ui/diagrampropertieseditordockwidget.cpp +++ b/sources/ui/diagrampropertieseditordockwidget.cpp @@ -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) { diff --git a/sources/ui/dynamicelementtextmodel.cpp b/sources/ui/dynamicelementtextmodel.cpp index 78a32c6e5..dee5f2e4f 100644 --- a/sources/ui/dynamicelementtextmodel.cpp +++ b/sources/ui/dynamicelementtextmodel.cpp @@ -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, diff --git a/sources/ui/potentialselectordialog.cpp b/sources/ui/potentialselectordialog.cpp index b3263e9cd..4ee05a4fa 100644 --- a/sources/ui/potentialselectordialog.cpp +++ b/sources/ui/potentialselectordialog.cpp @@ -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 &properties_list, QList &c_list) { diff --git a/sources/undocommand/addelementtextcommand.cpp b/sources/undocommand/addelementtextcommand.cpp index 427d74d2d..df1e996d9 100644 --- a/sources/undocommand/addelementtextcommand.cpp +++ b/sources/undocommand/addelementtextcommand.cpp @@ -116,6 +116,7 @@ AddTextsGroupCommand::AddTextsGroupCommand(Element *element, /** @brief AddTextsGroupCommand::AddTextsGroupCommand @param element : The element to add a new group + @param groupe_name @param texts_list : a list of texts to add to the created group (texts must be child of element) @param parent : parent undo diff --git a/sources/undocommand/changeelementinformationcommand.cpp b/sources/undocommand/changeelementinformationcommand.cpp index 5810e9a7b..4971e6d33 100644 --- a/sources/undocommand/changeelementinformationcommand.cpp +++ b/sources/undocommand/changeelementinformationcommand.cpp @@ -26,6 +26,7 @@ @param elmt : element to change information @param old_info : old info of element @param new_info : new info of element + @param parent */ ChangeElementInformationCommand::ChangeElementInformationCommand( Element *elmt,