Mod doc set style de same

This commit is contained in:
Simon De Backer
2020-08-16 11:19:36 +02:00
parent 90417ae509
commit d4ee161c07
274 changed files with 6823 additions and 6756 deletions

View File

@@ -21,12 +21,12 @@
#include <QObject>
/**
* @brief ChangeElementInformationCommand::ChangeElementInformationCommand
* Default constructor
* @param elmt : element to change information
* @param old_info : old info of element
* @param new_info : new info of element
*/
@brief ChangeElementInformationCommand::ChangeElementInformationCommand
Default constructor
@param elmt : element to change information
@param old_info : old info of element
@param new_info : new info of element
*/
ChangeElementInformationCommand::ChangeElementInformationCommand(Element *elmt, DiagramContext &old_info, DiagramContext &new_info, QUndoCommand *parent) :
QUndoCommand (parent),
m_element (elmt),
@@ -46,16 +46,16 @@ bool ChangeElementInformationCommand::mergeWith(const QUndoCommand *other)
}
/**
* @brief ChangeElementInformationCommand::undo
*/
@brief ChangeElementInformationCommand::undo
*/
void ChangeElementInformationCommand::undo() {
m_element -> setElementInformations(m_old_info);
updateProjectDB();
}
/**
* @brief ChangeElementInformationCommand::redo
*/
@brief ChangeElementInformationCommand::redo
*/
void ChangeElementInformationCommand::redo() {
m_element -> setElementInformations(m_new_info);
updateProjectDB();

View File

@@ -24,9 +24,9 @@
class Element;
/**
* @brief The ChangeElementInformationCommand class
* This class manage undo/redo to change the element information.
*/
@brief The ChangeElementInformationCommand class
This class manage undo/redo to change the element information.
*/
class ChangeElementInformationCommand : public QUndoCommand
{
public:

View File

@@ -20,12 +20,12 @@
#include "diagram.h"
/**
* @brief ChangeTitleBlockCommand::ChangeTitleBlockCommand
* @param d
* @param old_ip
* @param new_ip
* @param parent
*/
@brief ChangeTitleBlockCommand::ChangeTitleBlockCommand
@param d
@param old_ip
@param new_ip
@param parent
*/
ChangeTitleBlockCommand::ChangeTitleBlockCommand(
Diagram *d,
const TitleBlockProperties &old_ip,

View File

@@ -24,9 +24,9 @@
class Diagram;
/**
* @brief The ChangeTitleBlockCommand class
* This command changes the title block properties for a particular diagram.
*/
@brief The ChangeTitleBlockCommand class
This command changes the title block properties for a particular diagram.
*/
class ChangeTitleBlockCommand : public QUndoCommand
{
public:

View File

@@ -29,11 +29,11 @@
#include "qetdiagrameditor.h"
/**
* @brief DeleteQGraphicsItemCommand::DeleteQGraphicsItemCommand
* @param diagram : deigram where this undo work
* @param content : content to remove
* @param parent : parent undo
*/
@brief DeleteQGraphicsItemCommand::DeleteQGraphicsItemCommand
@param diagram : deigram where this undo work
@param content : content to remove
@param parent : parent undo
*/
DeleteQGraphicsItemCommand::DeleteQGraphicsItemCommand(Diagram *diagram, const DiagramContent &content, QUndoCommand *parent) :
QUndoCommand(parent),
m_removed_contents(content),
@@ -107,10 +107,10 @@ DeleteQGraphicsItemCommand::~DeleteQGraphicsItemCommand() {
}
/**
* @brief DeleteQGraphicsItemCommand::setPotentialsOfRemovedElements
* This function creates new conductors (if needed) for conserve the electrical potentials
* present at the terminals of each removed elements.
*/
@brief DeleteQGraphicsItemCommand::setPotentialsOfRemovedElements
This function creates new conductors (if needed) for conserve the electrical potentials
present at the terminals of each removed elements.
*/
void DeleteQGraphicsItemCommand::setPotentialsOfRemovedElements()
{
for (Element *elmt : m_removed_contents.m_elements)
@@ -194,14 +194,14 @@ void DeleteQGraphicsItemCommand::setPotentialsOfRemovedElements()
}
/**
* @brief DeleteQGraphicsItemCommand::terminalInSamePotential
* Return a terminal at the same potential of @terminal, by traveling through the conductors connected to @terminal
* only if the owner element of the terminal is not delete by this undo command.
* Return nullptr if a terminal can't be found.
* @param terminal - terminal from search
* @param conductor_to_exclude - a conductor to exlcude from search.
* @return
*/
@brief DeleteQGraphicsItemCommand::terminalInSamePotential
Return a terminal at the same potential of @terminal, by traveling through the conductors connected to @terminal
only if the owner element of the terminal is not delete by this undo command.
Return nullptr if a terminal can't be found.
@param terminal - terminal from search
@param conductor_to_exclude - a conductor to exlcude from search.
@return
*/
Terminal *DeleteQGraphicsItemCommand::terminalInSamePotential(Terminal *terminal, Conductor *conductor_to_exclude)
{
QList<Conductor *> conductor_list = terminal->conductors();
@@ -227,9 +227,9 @@ Terminal *DeleteQGraphicsItemCommand::terminalInSamePotential(Terminal *terminal
}
/**
* @brief DeleteQGraphicsItemCommand::undo
* Undo this command
*/
@brief DeleteQGraphicsItemCommand::undo
Undo this command
*/
void DeleteQGraphicsItemCommand::undo()
{
m_diagram->showMe();
@@ -265,9 +265,9 @@ void DeleteQGraphicsItemCommand::undo()
}
/**
* @brief DeleteQGraphicsItemCommand::redo
* Redo the delete command
*/
@brief DeleteQGraphicsItemCommand::redo
Redo the delete command
*/
void DeleteQGraphicsItemCommand::redo()
{
m_diagram -> showMe();

View File

@@ -18,11 +18,11 @@
#include "itemmodelcommand.h"
/**
* @brief ModelIndexCommand::ModelIndexCommand
* @param model
* @param index
* @param parent
*/
@brief ModelIndexCommand::ModelIndexCommand
@param model
@param index
@param parent
*/
ModelIndexCommand::ModelIndexCommand(QAbstractItemModel *model, const QModelIndex &index, QUndoCommand *parent):
QUndoCommand(parent),
m_model(model),
@@ -30,10 +30,10 @@ ModelIndexCommand::ModelIndexCommand(QAbstractItemModel *model, const QModelInde
{}
/**
* @brief ModelIndexCommand::setData
* @param value
* @param role
*/
@brief ModelIndexCommand::setData
@param value
@param role
*/
void ModelIndexCommand::setData(const QVariant &value, int role)
{
m_new_value = value;
@@ -47,9 +47,9 @@ void ModelIndexCommand::setData(const QVariant &value, int role)
}
/**
* @brief ModelIndexCommand::redo
* Reimplemented from QUndoCommand
*/
@brief ModelIndexCommand::redo
Reimplemented from QUndoCommand
*/
void ModelIndexCommand::redo() {
if (m_model && m_index.isValid()) {
m_model->setData(m_index, m_new_value, m_role);
@@ -57,9 +57,9 @@ void ModelIndexCommand::redo() {
}
/**
* @brief ModelIndexCommand::undo
* Reimplemented from QUndoCommand
*/
@brief ModelIndexCommand::undo
Reimplemented from QUndoCommand
*/
void ModelIndexCommand::undo() {
if (m_model && m_index.isValid()) {
m_model->setData(m_index, m_old_value, m_role);
@@ -67,23 +67,23 @@ void ModelIndexCommand::undo() {
}
/**
* @brief ModelHeaderDataCommand::ModelHeaderDataCommand
* @param model
* @param parent
*/
@brief ModelHeaderDataCommand::ModelHeaderDataCommand
@param model
@param parent
*/
ModelHeaderDataCommand::ModelHeaderDataCommand(QAbstractItemModel *model, QUndoCommand *parent) :
QUndoCommand(parent),
m_model(model)
{}
/**
* @brief ModelHeaderDataCommand::setData
* See QAbstractItemModel::setHeaderData
* @param section
* @param orientation
* @param value
* @param role
*/
@brief ModelHeaderDataCommand::setData
See QAbstractItemModel::setHeaderData
@param section
@param orientation
@param value
@param role
*/
void ModelHeaderDataCommand::setData(int section, Qt::Orientation orientation, const QVariant &value, int role)
{
m_section = section;
@@ -98,9 +98,9 @@ void ModelHeaderDataCommand::setData(int section, Qt::Orientation orientation, c
}
/**
* @brief ModelHeaderDataCommand::redo
* Reimplemented from QUndoCommand
*/
@brief ModelHeaderDataCommand::redo
Reimplemented from QUndoCommand
*/
void ModelHeaderDataCommand::redo()
{
if (m_model) {
@@ -109,9 +109,9 @@ void ModelHeaderDataCommand::redo()
}
/**
* @brief ModelHeaderDataCommand::undo
* Reimplemented from QUndoCommand
*/
@brief ModelHeaderDataCommand::undo
Reimplemented from QUndoCommand
*/
void ModelHeaderDataCommand::undo()
{
if (m_model) {

View File

@@ -25,9 +25,9 @@
class QAbstractItemModel;
/**
* @brief The ModelIndexCommand class
* Change a data of an index of QAbstractItemModel
*/
@brief The ModelIndexCommand class
Change a data of an index of QAbstractItemModel
*/
class ModelIndexCommand : public QUndoCommand
{
public:
@@ -46,9 +46,9 @@ class ModelIndexCommand : public QUndoCommand
};
/**
* @brief The ModelHeaderDataCommand class
* Change the data of a header
*/
@brief The ModelHeaderDataCommand class
Change the data of a header
*/
class ModelHeaderDataCommand : public QUndoCommand
{
public:

View File

@@ -23,11 +23,11 @@
#include "potentialselectordialog.h"
/**
* @brief LinkElementCommand::LinkElementCommand
* Constructor
* @param element_ : element where we work the link / unlink
* @param parent : parent undo
*/
@brief LinkElementCommand::LinkElementCommand
Constructor
@param element_ : element where we work the link / unlink
@param parent : parent undo
*/
LinkElementCommand::LinkElementCommand(Element *element_, QUndoCommand *parent):
QUndoCommand(parent),
m_element(element_),
@@ -38,10 +38,10 @@ LinkElementCommand::LinkElementCommand(Element *element_, QUndoCommand *parent):
}
/**
* @brief LinkElementCommand::mergeWith
* @param other try to merge this command with other
* @return true if merge with success else false
*/
@brief LinkElementCommand::mergeWith
@param other try to merge this command with other
@return true if merge with success else false
*/
bool LinkElementCommand::mergeWith(const QUndoCommand *other)
{
if (id() != other->id() || other->childCount()) return false;
@@ -52,17 +52,17 @@ bool LinkElementCommand::mergeWith(const QUndoCommand *other)
}
/**
* @brief LinkElementCommand::isLinkable
* @param element_a
* @param element_b
* @param already_linked
* @return true if element_a and element_b can be linked between them.
* There is few condition to be linked :
* 1- element_a and element_b must be linkable type. (Ex : A is master and B is slave 'OK', A and B is master 'KO')
* 2- For element type slave and report (no matter if element is 'A' or 'B'), the element must be free (not connected to an element)
* 3- we can override the section 2 by set already_linked to true. In this case, if slave or report is already
* linked to the other element ('A' or 'B') return true, but if linked to another element (not 'A' or 'B') return false
*/
@brief LinkElementCommand::isLinkable
@param element_a
@param element_b
@param already_linked
@return true if element_a and element_b can be linked between them.
There is few condition to be linked :
1- element_a and element_b must be linkable type. (Ex : A is master and B is slave 'OK', A and B is master 'KO')
2- For element type slave and report (no matter if element is 'A' or 'B'), the element must be free (not connected to an element)
3- we can override the section 2 by set already_linked to true. In this case, if slave or report is already
linked to the other element ('A' or 'B') return true, but if linked to another element (not 'A' or 'B') return false
*/
bool LinkElementCommand::isLinkable(Element *element_a, Element *element_b, bool already_linked)
{
switch(element_a->linkType())
@@ -124,11 +124,11 @@ bool LinkElementCommand::isLinkable(Element *element_a, Element *element_b, bool
}
/**
* @brief LinkElementCommand::setLink
* Replace all linked elements of edited element by elements stored in @element_list
* This method do several check to know if element can be linked or not.
* @param element_list
*/
@brief LinkElementCommand::setLink
Replace all linked elements of edited element by elements stored in @element_list
This method do several check to know if element can be linked or not.
@param element_list
*/
void LinkElementCommand::setLink(const QList<Element *>& element_list)
{
m_linked_after.clear();
@@ -136,10 +136,10 @@ void LinkElementCommand::setLink(const QList<Element *>& element_list)
}
/**
* @brief LinkElementCommand::setLink
* This is an overloaded function.
* @param element_
*/
@brief LinkElementCommand::setLink
This is an overloaded function.
@param element_
*/
void LinkElementCommand::setLink(Element *element_)
{
QList<Element *> list;
@@ -148,10 +148,10 @@ void LinkElementCommand::setLink(Element *element_)
}
/**
* @brief LinkElementCommand::unlink
* Unlink all elements of element_list from the edited element.
* @param element_list
*/
@brief LinkElementCommand::unlink
Unlink all elements of element_list from the edited element.
@param element_list
*/
void LinkElementCommand::unlink(QList<Element *> element_list)
{
foreach(Element *elmt, element_list)
@@ -159,17 +159,17 @@ void LinkElementCommand::unlink(QList<Element *> element_list)
}
/**
* @brief LinkElementCommand::unlinkAll
* Unlink all element of the edited element
*/
@brief LinkElementCommand::unlinkAll
Unlink all element of the edited element
*/
void LinkElementCommand::unlinkAll() {
m_linked_after.clear();
}
/**
* @brief LinkElementCommand::undo
* Undo this command
*/
@brief LinkElementCommand::undo
Undo this command
*/
void LinkElementCommand::undo()
{
if(m_element->diagram()) m_element->diagram()->showMe();
@@ -178,9 +178,9 @@ void LinkElementCommand::undo()
}
/**
* @brief LinkElementCommand::redo
* Redo this command
*/
@brief LinkElementCommand::redo
Redo this command
*/
void LinkElementCommand::redo()
{
if(m_element->diagram()) m_element->diagram()->showMe();
@@ -221,13 +221,13 @@ void LinkElementCommand::redo()
}
/**
* @brief LinkElementCommand::setUpNewLink
* Update the content of m_link_after with the content of @element_list.
* Each linkable element (know via the static method isLinkable) is added to m_linked_after
* @already_link is used for the static method isLinkable.
* @param element_list
* @param already_link
*/
@brief LinkElementCommand::setUpNewLink
Update the content of m_link_after with the content of @element_list.
Each linkable element (know via the static method isLinkable) is added to m_linked_after
@already_link is used for the static method isLinkable.
@param element_list
@param already_link
*/
void LinkElementCommand::setUpNewLink(const QList<Element *> &element_list, bool already_link)
{
//m_element is a master we can connect several element to it
@@ -252,11 +252,11 @@ void LinkElementCommand::setUpNewLink(const QList<Element *> &element_list, bool
}
/**
* @brief LinkElementCommand::makeLink
* Make the link between m_element and element_list;
* This method unlink elements if needed.
* @param element_list
*/
@brief LinkElementCommand::makeLink
Make the link between m_element and element_list;
This method unlink elements if needed.
@param element_list
*/
void LinkElementCommand::makeLink(const QList<Element *> &element_list)
{
//List is empty, that mean m_element must be free, so we unlink all elements

View File

@@ -23,11 +23,11 @@
class Element;
/**
* @brief The LinkElementCommand class
* This undo class manage link between elements.
* In the same instance of this class, we can link and unlink elements from an edited element
* This undo class support the merge.
*/
@brief The LinkElementCommand class
This undo class manage link between elements.
In the same instance of this class, we can link and unlink elements from an edited element
This undo class support the merge.
*/
class LinkElementCommand : public QUndoCommand
{
public:

View File

@@ -80,8 +80,8 @@ m_diagram(diagram)
}
/**
* @brief RotateSelectionCommand::undo
*/
@brief RotateSelectionCommand::undo
*/
void RotateSelectionCommand::undo()
{
m_diagram->showMe();
@@ -96,8 +96,8 @@ void RotateSelectionCommand::undo()
}
/**
* @brief RotateSelectionCommand::redo
*/
@brief RotateSelectionCommand::redo
*/
void RotateSelectionCommand::redo()
{
m_diagram->showMe();
@@ -111,9 +111,9 @@ void RotateSelectionCommand::redo()
}
/**
* @brief RotateSelectionCommand::isValid
* @return true if this command rotate a least one item.
*/
@brief RotateSelectionCommand::isValid
@return true if this command rotate a least one item.
*/
bool RotateSelectionCommand::isValid()
{
if(childCount())

View File

@@ -26,9 +26,9 @@ class ConductorTextItem;
class QPropertyUndoCommand;
/**
* @brief The RotateSelectionCommand class
* Rotate the selected items in the given diagram
*/
@brief The RotateSelectionCommand class
Rotate the selected items in the given diagram
*/
class RotateSelectionCommand : public QUndoCommand
{
public:

View File

@@ -25,11 +25,11 @@
#include "qtextorientationspinboxwidget.h"
/**
* @brief RotateTextsCommand::RotateTextsCommand
* @param diagram : Apply the rotation to the selected texts and group of texts
* of diagram at construction time.
* @param parent : undo parent
*/
@brief RotateTextsCommand::RotateTextsCommand
@param diagram : Apply the rotation to the selected texts and group of texts
of diagram at construction time.
@param parent : undo parent
*/
RotateTextsCommand::RotateTextsCommand(Diagram *diagram, QUndoCommand *parent) :
QUndoCommand(parent),
m_diagram(diagram)

View File

@@ -26,10 +26,10 @@ class Diagram;
class QParallelAnimationGroup;
/**
* @brief The RotateTextsCommand class
* Open a dialog for edit the rotation of the current selected texts and texts group in diagram.
* Just instantiate this undo command and push it in a QUndoStack.
*/
@brief The RotateTextsCommand class
Open a dialog for edit the rotation of the current selected texts and texts group in diagram.
Just instantiate this undo command and push it in a QUndoStack.
*/
class RotateTextsCommand : public QUndoCommand
{
public: