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

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

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

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

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)

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