Fix some doxygen issues

This commit is contained in:
Simon De Backer
2020-08-18 21:28:52 +02:00
parent ef15013715
commit 8e956df8d8
33 changed files with 204 additions and 159 deletions

View File

@@ -970,7 +970,7 @@ void Conductor::pointsToSegments(const QList<QPointF>& points_list) {
/**
@brief Conductor::fromXml
Load the conductor and her information from xml element
@param e
@param dom_element
@return true is loading success else return false
*/
bool Conductor::fromXml(QDomElement &dom_element)
@@ -998,9 +998,12 @@ bool Conductor::fromXml(QDomElement &dom_element)
}
/**
@brief Conductor::toXml
Exporte les caracteristiques du conducteur sous forme d'une element XML.
@param d Le document XML a utiliser pour creer l'element XML
@param table_adr_id Hash stockant les correspondances entre les ids des
@param dom_document :
Le document XML a utiliser pour creer l'element XML
@param table_adr_id :
Hash stockant les correspondances entre les ids des
bornes dans le document XML et leur adresse en memoire
@return Un element XML representant le conducteur
*/
@@ -1492,9 +1495,12 @@ QPainterPath Conductor::path() const
@brief Conductor::setPropertiesToPotential
@param properties
@param only_text
Set @propertie to conductor and every conductors in the same potential of @conductor.
If @only_text is true only formula, text, function and tension/protocol is set
to other conductor in the same potential, the other values of property stay unmodified
Set propertie to conductor and every conductors in
the same potential of conductor.
If only_text is true only formula, text,
function and tension/protocol is set
to other conductor in the same potential,
the other values of property stay unmodified
*/
void Conductor::setPropertyToPotential(const ConductorProperties &property, bool only_text)
{
@@ -1523,7 +1529,7 @@ void Conductor::setPropertyToPotential(const ConductorProperties &property, bool
/**
@brief Conductor::setProperties
Set @property as current property of conductor
Set property as current property of conductor
@param properties : properties
*/
void Conductor::setProperties(const ConductorProperties &property)
@@ -1628,11 +1634,11 @@ void Conductor::displayedTextChanged()
/**
@brief Conductor::relatedPotentialConductors
Return all conductors at the same potential of this conductor, this conductor isn't
part of the returned QSet.
Return all conductors at the same potential of this conductor,
this conductor isn't part of the returned QSet.
@param all_diagram : if true search in all diagram of the project,
false search only in the parent diagram of this conductor
@param t_list, a list of terminal already found for this potential.
@param t_list : a list of terminal already found for this potential.
@return a QSet of conductor at the same potential.
*/
QSet<Conductor *> Conductor::relatedPotentialConductors(const bool all_diagram, QList <Terminal *> *t_list)

View File

@@ -233,7 +233,7 @@ void CrossRefItem::updateLabel()
Calculate and set position automaticaly.
*/
void CrossRefItem::autoPos() {
//We calcul the position according to the @snapTo of the xrefproperties
//We calcul the position according to the snapTo of the xrefproperties
if (m_properties.snapTo() == XRefProperties::Bottom)
centerToBottomDiagram(this,
m_element,

View File

@@ -125,7 +125,7 @@ QString DiagramImageItem::name() const {
/**
@brief DiagramImageItem::fromXml
Load this image fro xml elemebt @e
Load this image fro xml elemebt e
@param e
@return true if succesfully load.
*/
@@ -140,11 +140,11 @@ bool DiagramImageItem::fromXml(const QDomElement &e)
return (false);
}
//load xml image to QByteArray
//load xml image to QByteArray
QByteArray array;
array = QByteArray::fromBase64(e.text().toLatin1());
//Set QPixmap from the @array
//Set QPixmap from the array
QPixmap pixmap;
pixmap.loadFromData(array);
setPixmap(pixmap);

View File

@@ -382,7 +382,7 @@ QString DynamicElementTextItem::text() const {
/**
@brief DynamicElementTextItem::setText
Set the text of this text
@param formula
@param text
*/
void DynamicElementTextItem::setText(const QString &text)
{
@@ -448,7 +448,7 @@ QString DynamicElementTextItem::infoName() const {
/**
@brief DynamicElementTextItem::setCompositeText
Set the composite text of this text item to @text
Set the composite text of this text item to text
@param text
*/
void DynamicElementTextItem::setCompositeText(const QString &text)

View File

@@ -71,9 +71,10 @@ class ElementXmlRetroCompatibility
/**
@brief Element::Element
@param location, location of this element
@param parent, parent graphics item
@param state, state of the instanciation
@param location : location of this element
@param parent : parent graphics item
@param state : state of the instanciation
@param link_type
*/
Element::Element(const ElementsLocation &location,
QGraphicsItem *parent,
@@ -589,7 +590,7 @@ bool Element::parseInput(const QDomElement &dom_element)
/**
@brief Element::parseDynamicText
Create the dynamic text field describ in @dom_element
Create the dynamic text field describ in dom_element
@param dom_element
@return
*/
@@ -868,7 +869,7 @@ bool Element::fromXml(QDomElement &e,
transform.translate(xml_pos.x(), xml_pos.y());
deti->setPos(transform.map(pos));
//dom_input and deti matched we remove the dom_input from @inputs list,
//dom_input and deti matched we remove the dom_input from inputs list,
//to avoid unnecessary checking made below
//we also move deti from the m_converted_text_from_xml_description to m_dynamic_text_list
inputs.removeAll(dom_input);
@@ -905,12 +906,15 @@ bool Element::fromXml(QDomElement &e,
DiagramContext dc;
dc.fromXml(e.firstChildElement("elementInformations"),
"elementInformation");
/**
* Since the commit 4791, the value used as "label" and "formula" is stored in differents keys (instead of the same key, "label" in previous version),
* so, if "label" contain "%" (Use variable value), and "formula" does not exist,
* this mean the label was made before commit 4791 (0.51 dev). So we swap the value stored in "label" to "formula" as expected.
* @TODO remove this code at version 0.7 or more (probably useless).
*/
/*
* Since the commit 4791, the value used as "label" and "formula"
* is stored in differents keys (instead of the same key,
* "label" in previous version), so, if "label" contain "%"
* (Use variable value), and "formula" does not exist,
* this mean the label was made before commit 4791 (0.51 dev).
* So we swap the value stored in "label" to "formula" as expected.
* @TODO remove this code at version 0.7 or more (probably useless).
*/
#pragma message("@TODO remove this code for qet 0.7 or later")
if (dc["label"].toString().contains("%")
&& dc["formula"].toString().isNull())
@@ -922,8 +926,8 @@ bool Element::fromXml(QDomElement &e,
!m_element_informations.value("label").toString().isEmpty())
dc.addValue("label", m_element_informations.value("label"));
//We must to block the update of the alignment when load the information
//otherwise the pos of the text will not be the same as it was at save time.
//We must to block the update of the alignment when load the information
//otherwise the pos of the text will not be the same as it was at save time.
for(DynamicElementTextItem *deti : m_dynamic_text_list)
deti->m_block_alignment = true;
setElementInformations(dc);
@@ -931,17 +935,21 @@ bool Element::fromXml(QDomElement &e,
deti->m_block_alignment = false;
/**
During the devel of the version 0.7, the "old text" was replaced by the dynamic element text item.
When open a project made befor the 0.7, we must to reproduce the same visual when the label are not empty and visible,
and comment are not empty and visible and/or location are not empty and visible.
we create a text group with inside the needed texts, label and comment and/or location.
*/
//#1 There must be old text converted to dynamic text
/* During the devel of the version 0.7,
* the "old text" was replaced by the dynamic element text item.
* When open a project made befor the 0.7,
* we must to reproduce the same visual when
* the label are not empty and visible,
* and comment are not empty
* and visible and/or location are not empty and visible.
* we create a text group with inside the needed texts,
* label and comment and/or location.
*/
//#1 There must be old text converted to dynamic text
if(!successfully_converted.isEmpty())
{
//#2 the element information must have label not empty and visible
//and a least comment or location not empty and visible
//#2 the element information must have label not empty and visible
//and a least comment or location not empty and visible
QString label = m_element_informations.value(
"label").toString();
QString comment = m_element_informations.value(
@@ -963,7 +971,7 @@ bool Element::fromXml(QDomElement &e,
((!comment.isEmpty() && c)
|| (!location.isEmpty() && lo)))
{
//#2 in the converted list one text must have text from = element info and info name = label
//#2 in the converted list one text must have text from = element info and info name = label
for(DynamicElementTextItem *deti
: successfully_converted)
{
@@ -994,7 +1002,7 @@ bool Element::fromXml(QDomElement &e,
comment_text->setPos(deti->x(), deti->y()+10); //+10 is arbitrary, comment_text must be below deti
addDynamicTextItem(comment_text);
}
//create the location item
//create the location item
DynamicElementTextItem *location_text = nullptr;
if (m_link_type !=PreviousReport || m_link_type !=NextReport)
{
@@ -1022,7 +1030,7 @@ bool Element::fromXml(QDomElement &e,
m_state = QET::GIOK;
return(true);
}
//Create the group
//Create the group
ElementTextItemGroup *group =
addTextGroup(tr("Label + commentaire"));
addTextToGroup(deti, group);
@@ -1035,8 +1043,9 @@ bool Element::fromXml(QDomElement &e,
group->setAlignment(Qt::AlignVCenter);
group->setVerticalAdjustment(-4);
group->setRotation(rotation);
//Change the position of the group, so that the text "label" stay in the same
//position in scene coordinate
//Change the position of the group,
//so that the text "label" stay in the same
//position in scene coordinate
group->setPos(pos - deti->pos());
break;
@@ -1046,10 +1055,10 @@ bool Element::fromXml(QDomElement &e,
}
else
{
//This element is supposed to be a master and Xref property snap to bottom
//This element is supposed to be a master and Xref property snap to bottom
if((!comment.isEmpty() && c) || (!location.isEmpty() && lo))
{
//Create the comment item
//Create the comment item
DynamicElementTextItem *comment_text = nullptr;
if(!comment.isEmpty() && c)
{
@@ -1065,7 +1074,7 @@ bool Element::fromXml(QDomElement &e,
comment_text->setTextWidth(80);
addDynamicTextItem(comment_text);
}
//create the location item
//create the location item
DynamicElementTextItem *location_text = nullptr;
if(!location.isEmpty() && lo)
{
@@ -1085,7 +1094,7 @@ bool Element::fromXml(QDomElement &e,
addDynamicTextItem(location_text);
}
//Create the group
//Create the group
ElementTextItemGroup *group =
addTextGroup(tr("Label + commentaire"));
if(comment_text)
@@ -1246,8 +1255,10 @@ QDomElement Element::toXml(QDomDocument &document,
/**
@brief Element::addDynamiqueTextItem
Add @deti as a dynamic text item of this element, @deti is reparented to this
If @deti is null, a new DynamicElementTextItem is created and added to this element.
Add deti as a dynamic text item of this element,
deti is reparented to this
If deti is null, a new DynamicElementTextItem is created
and added to this element.
@param deti
*/
void Element::addDynamicTextItem(DynamicElementTextItem *deti)
@@ -1268,8 +1279,9 @@ void Element::addDynamicTextItem(DynamicElementTextItem *deti)
/**
@brief Element::removeDynamicTextItem
Remove @deti, no matter if is a child of this element or a child of a group of this element.
Set he parent item of @deti to 0, @deti is not deleted.
Remove deti, no matter if is a child of this element
or a child of a group of this element.
Set he parent item of deti to 0, deti is not deleted.
@param deti
*/
void Element::removeDynamicTextItem(DynamicElementTextItem *deti)
@@ -1309,7 +1321,7 @@ QList<DynamicElementTextItem *> Element::dynamicTextItems() const {
@brief Element::addTextGroup
Create and add an element text item group to this element.
If this element already have a group with the same name,
then @name will renamed to name1 or name2 etc....
then name will renamed to name1 or name2 etc....
@param name : the name of the group
@return the created group.
*/
@@ -1342,7 +1354,7 @@ ElementTextItemGroup *Element::addTextGroup(const QString &name)
/**
@brief Element::addTextGroup
@param group add group @group to the group of this element.
@param group add group to the group of this element.
the group must not be owned by an element.
*/
void Element::addTextGroup(ElementTextItemGroup *group)
@@ -1357,7 +1369,8 @@ void Element::addTextGroup(ElementTextItemGroup *group)
/**
@brief Element::removeTextGroup
Remove the text group @group from this element, and set the parent of group to 0.
Remove the text group group from this element,
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
@@ -1388,7 +1401,7 @@ void Element::removeTextGroup(ElementTextItemGroup *group)
/**
@brief Element::textGroup
@param name
@return the text group named @name or nullptr if this element
@return the text group named name or nullptr if this element
haven't got a group with this name
*/
ElementTextItemGroup *Element::textGroup(const QString &name) const
@@ -1411,8 +1424,8 @@ QList<ElementTextItemGroup *> Element::textGroups() const
/**
@brief Element::addTextToGroup
Add the text @text to the group @group;
If @group isn't owned by this element return false.
Add the text text to the group group;
If group isn't owned by this element return false.
The text must be a text of this element.
@return : true if the text was succesfully added to the group.
*/
@@ -1435,7 +1448,8 @@ bool Element::addTextToGroup(DynamicElementTextItem *text,
/**
@brief Element::removeTextFromGroup
Remove the text @text from the group @group, en reparent @text to this element
Remove the text text from the group group,
en reparent text to this element
@return true if text was succesfully removed
*/
bool Element::removeTextFromGroup(DynamicElementTextItem *text,
@@ -1526,7 +1540,7 @@ QString Element::linkTypeToString() const
/**
@brief Element::setElementInformations
Set new information for this element.
If new information is different of current infotmation emit @elementInfoChange
If new information is different of current infotmation emit elementInfoChange
@param dc
*/
void Element::setElementInformations(DiagramContext dc)

View File

@@ -44,8 +44,9 @@ class Element : public QetGraphicsItem
Q_OBJECT
public:
/**
* @brief The kind enum
* Used to know the kind of this element (master, slave, report ect...)
@brief The kind enum
Used to know the kind of this element
(master, slave, report ect...)
*/
enum kind {Simple = 1,
NextReport = 2,
@@ -66,8 +67,9 @@ class Element : public QetGraphicsItem
// attributes
public:
/**
* Enable the use of qgraphicsitem_cast to safely cast a QGraphicsItem into an Element.
* @return the QGraphicsItem type
Enable the use of qgraphicsitem_cast
to safely cast a QGraphicsItem into an Element.
@return the QGraphicsItem type
*/
enum { Type = UserType + 1000 };
int type() const override { return Type; }
@@ -153,7 +155,7 @@ class Element : public QetGraphicsItem
virtual void unlinkElement(Element *) {}
virtual void initLink(QETProject *);
QList<Element *> linkedElements ();
virtual kind linkType() const {return m_link_type;} // @return the linkable type
virtual kind linkType() const {return m_link_type;} // return the linkable type
QString linkTypeToString() const;
void newUuid() {m_uuid = QUuid::createUuid();} //create new uuid for this element
@@ -187,7 +189,7 @@ class Element : public QetGraphicsItem
void hoverLeaveEvent(QGraphicsSceneHoverEvent *) override;
protected:
// @m_converted_text_from_description, when a element is created from his description, the old element text item (tagged as 'input' in the xml)
// m_converted_text_from_description, when a element is created from his description, the old element text item (tagged as 'input' in the xml)
// are converted to dynamic text field, the QPointF is the original position of the text item, because the origin transformation point of text item
// and dynamic text item are not the same, so we must to keep a track of this value, to be use in the function element::fromXml
QHash <DynamicElementTextItem *, QPointF>
@@ -241,16 +243,16 @@ inline int Element::orientation() const {
}
/**
* @brief Element::uuid
* @return the uuid of this element
@brief Element::uuid
@return the uuid of this element
*/
inline QUuid Element::uuid() const {
return m_uuid;
}
/**
* @brief Element::linkedElements
* @return the list of linked elements, the list is sorted by position
@brief Element::linkedElements
@return the list of linked elements, the list is sorted by position
*/
inline QList <Element *> Element::linkedElements() {
std::sort(connected_elements.begin(),

View File

@@ -236,8 +236,9 @@ void ElementTextItemGroup::updateAlignment()
/**
@brief ElementTextItemGroup::setVerticalAdjustment
Set the value of the vertical adjustment to @v.
The vertical adjutment is use to adjust the space between the texts of this group.
Set the value of the vertical adjustment to v.
The vertical adjutment is use to adjust
the space between the texts of this group.
@param v
*/
void ElementTextItemGroup::setVerticalAdjustment(int v)

View File

@@ -961,6 +961,7 @@ QDomElement QetShapeItem::toXml(QDomDocument &document) const
@brief QetShapeItem::toDXF
Draw this element to the dxf document
@param filepath file path of the the dxf document
@param pen
@return true if draw success
*/
bool QetShapeItem::toDXF(const QString &filepath,const QPen &pen)

View File

@@ -65,7 +65,8 @@ class QetShapeItem : public QetGraphicsItem
QetShapeItem(QPointF, QPointF = QPointF(0,0), ShapeType = Line, QGraphicsItem *parent = nullptr);
~QetShapeItem() override;
//Enable the use of qgraphicsitem_cast to safely cast a QGraphicsItem into a QetShapeItem @return the QGraphicsItem type
//Enable the use of qgraphicsitem_cast to safely cast a
//QGraphicsItem into a QetShapeItem return the QGraphicsItem type
int type() const override { return Type; }
///METHODS

View File

@@ -34,11 +34,11 @@ const qreal Terminal::terminalSize = 4.0;
const qreal Terminal::Z = 1000;
/**
@brief Terminal::init
Methode privee pour initialiser la borne.
@param pf position du point d'amarrage pour un conducteur
@param o orientation de la borne : Qt::Horizontal ou Qt::Vertical
@param number of terminal
@param name of terminal
@param hiddenName
*/
void Terminal::init(QString number, QString name, bool hiddenName) {
@@ -97,7 +97,6 @@ void Terminal::init(QPointF pf, Qet::Orientation o, QString number, QString name
@param pf position du point d'amarrage pour un conducteur
@param o orientation de la borne : Qt::Horizontal ou Qt::Vertical
@param e Element auquel cette borne appartient
@param s Scene sur laquelle figure cette borne
*/
Terminal::Terminal(QPointF pf, Qet::Orientation o, Element *e) :
QGraphicsObject(e),
@@ -690,7 +689,7 @@ bool Terminal::isLinkedTo(Terminal *other_terminal) {
- \p other_terminal is this terminal
- this terminal is already connected to \p other_terminal
@param other_terminal
@return true if this terminal can be linked to @other_terminal,
@return true if this terminal can be linked to other_terminal,
otherwise false
*/
bool Terminal::canBeLinkedTo(Terminal *other_terminal)
@@ -823,12 +822,12 @@ QUuid Terminal::uuid() const {
/**
@brief Conductor::relatedPotentialTerminal
Return terminal at the same potential from the same
parent element of @terminal.
parent element of terminal.
For folio report, return the terminal of linked other report.
For Terminal element, return the other terminal of terminal element.
@param terminal : to start search
@param all_diagram :if true return all related terminal,
false return only terminal in the same diagram of @t
false return only terminal in the same diagram of t
@return the list of terminal at the same potential
*/
QList<Terminal *> relatedPotentialTerminal (const Terminal *terminal, const bool all_diagram)