mirror of
https://github.com/qelectrotech/qelectrotech-source-mirror.git
synced 2026-05-14 22:59:59 +02:00
Fix some doxygen issues
This commit is contained in:
@@ -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) {
|
||||
|
||||
@@ -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)
|
||||
{
|
||||
|
||||
@@ -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),
|
||||
|
||||
@@ -262,7 +262,7 @@ void DiagramTextItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *o
|
||||
|
||||
/**
|
||||
@brief DiagramTextItem::focusInEvent
|
||||
@param e
|
||||
@param event
|
||||
*/
|
||||
void DiagramTextItem::focusInEvent(QFocusEvent *event)
|
||||
{
|
||||
|
||||
@@ -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 <QPair <Terminal *, Terminal *> > 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)
|
||||
|
||||
@@ -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;}
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
#include <QGraphicsSceneMouseEvent>
|
||||
#include <utility>
|
||||
|
||||
/**
|
||||
@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());
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
Reference in New Issue
Block a user