kotschak/qelectrotech-source-mirror
0
0
Fork 0
mirror of https://github.com/qelectrotech/qelectrotech-source-mirror.git synced 2026-03-21 12: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-20 21:57:35 +02:00
parent 8626ca5d1b
commit 0c00d83b27
57 changed files with 270 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
sources/editor/UndoCommand/pastepartscommand.cpp
View File

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

27
sources/editor/editorcommands.cpp
View File

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

17
sources/editor/elementprimitivedecorator.cpp
View File

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

2
sources/editor/elementscene.cpp
View File

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

9
sources/editor/elementview.cpp
View File

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

1
sources/editor/graphicspart/customelementgraphicpart.cpp
View File

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

6
sources/editor/graphicspart/partdynamictextfield.cpp
View File

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

4
sources/editor/graphicspart/partpolygon.cpp
View File

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

9
sources/editor/graphicspart/partterminal.cpp
View File

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

18
sources/editor/graphicspart/parttext.cpp
View File

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

4
sources/editor/ui/dynamictextfieldeditor.cpp
View File

@@ -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();