kotschak/qelectrotech-source-mirror
0
0
Fork 0
mirror of https://github.com/qelectrotech/qelectrotech-source-mirror.git synced 2025-12-17 20:50:34 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Mod doc to set style de same + Fix indentation code

Browse Source
This commit is contained in:
Simon De Backer
2020-07-15 18:17:39 +02:00
committed by Laurent Trinques
parent 251dfdf37a
commit 2cdfce18ec
11 changed files with 252 additions and 245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
sources/diagramcommands.cpp
View File

@@ -43,11 +43,11 @@ QString itemText(const Conductor *item) {
}
/**
* @brief PasteDiagramCommand::PasteDiagramCommand
* Constructor
* @param dia : diagram where we must to paste
* @param c : content to past
* @param parent : parent undo command
@brief PasteDiagramCommand::PasteDiagramCommand
Constructor
@param dia : diagram where we must to paste
@param c : content to past
@param parent : parent undo command
*/
PasteDiagramCommand::PasteDiagramCommand( Diagram *dia, const DiagramContent &c, QUndoCommand *parent) :
QUndoCommand(parent),
@@ -61,16 +61,16 @@ PasteDiagramCommand::PasteDiagramCommand( Diagram *dia, const DiagramContent &c,
}
/**
* @brief PasteDiagramCommand::~PasteDiagramCommand
* Destructor
@brief PasteDiagramCommand::~PasteDiagramCommand
Destructor
*/
PasteDiagramCommand::~PasteDiagramCommand() {
diagram -> qgiManager().release(content.items(filter));
}
/**
* @brief PasteDiagramCommand::undo
* Undo this command
@brief PasteDiagramCommand::undo
Undo this command
*/
void PasteDiagramCommand::undo()
{
@@ -81,8 +81,8 @@ void PasteDiagramCommand::undo()
}
/**
* @brief PasteDiagramCommand::redo
* Redo this commnand
@brief PasteDiagramCommand::redo
Redo this commnand
*/
void PasteDiagramCommand::redo()
{
@@ -166,12 +166,12 @@ CutDiagramCommand::~CutDiagramCommand() {
}
/**
* @brief MoveElementsCommand::MoveElementsCommand
* Constructor
* @param dia diagram
* @param diagram_content diagram content (contain all items to be moved)
* @param m movement to applied
* @param parent parent undo command
@brief MoveElementsCommand::MoveElementsCommand
Constructor
@param dia diagram
@param diagram_content diagram content (contain all items to be moved)
@param m movement to applied
@param parent parent undo command
*/
MoveElementsCommand::MoveElementsCommand(
Diagram *dia,
@@ -207,15 +207,15 @@ MoveElementsCommand::MoveElementsCommand(
}
/**
* @brief MoveElementsCommand::~MoveElementsCommand
* Destructor
@brief MoveElementsCommand::~MoveElementsCommand
Destructor
*/
MoveElementsCommand::~MoveElementsCommand() {
delete m_anim_group;
}
/**
* @brief MoveElementsCommand::undo
@brief MoveElementsCommand::undo
*/
void MoveElementsCommand::undo() {
diagram -> showMe();
@@ -225,7 +225,7 @@ void MoveElementsCommand::undo() {
}
/**
* @brief MoveElementsCommand::redo
@brief MoveElementsCommand::redo
*/
void MoveElementsCommand::redo() {
diagram -> showMe();
@@ -241,9 +241,9 @@ void MoveElementsCommand::redo() {
}
/**
* @brief MoveElementsCommand::move
* Move item and conductor to @actual_movement
* @param actual_movement movement to be applied
@brief MoveElementsCommand::move
Move item and conductor to @actual_movement
@param actual_movement movement to be applied
*/
void MoveElementsCommand::move(const QPointF &actual_movement)
{
@@ -262,6 +262,7 @@ void MoveElementsCommand::move(const QPointF &actual_movement)
setupAnimation(qgi->toGraphicsObject(), "pos", qgi->pos(), qgi->pos() + actual_movement);
else if(qgi->type() == QGraphicsItemGroup::Type) //ElementTextItemGroup is a QObject but not a QGraphicsObject
{
//ElementTextItemGroup is a QObject but not a QGraphicsObject
if(ElementTextItemGroup *etig = dynamic_cast<ElementTextItemGroup *>(qgi))
setupAnimation(etig, "pos", etig->pos(), etig->pos() + actual_movement);
}
@@ -511,9 +512,9 @@ void ChangeConductorCommand::setConductorTextItemMove(const QPointF &pos_before,
}
/**
* @brief ResetConductorCommand::ResetConductorCommand
* @param cp
* @param parent
@brief ResetConductorCommand::ResetConductorCommand
@param cp
@param parent
*/
ResetConductorCommand::ResetConductorCommand(
const QHash<Conductor *, ConductorProfilesGroup> &cp,
@@ -532,13 +533,13 @@ ResetConductorCommand::ResetConductorCommand(
}
/**
* @brief ResetConductorCommand::~ResetConductorCommand
@brief ResetConductorCommand::~ResetConductorCommand
*/
ResetConductorCommand::~ResetConductorCommand() {
}
/**
* @brief ResetConductorCommand::undo
@brief ResetConductorCommand::undo
*/
void ResetConductorCommand::undo() {
diagram -> showMe();
@@ -548,7 +549,7 @@ void ResetConductorCommand::undo() {
}
/**
* @brief ResetConductorCommand::redo
@brief ResetConductorCommand::redo
*/
void ResetConductorCommand::redo() {
diagram -> showMe();

6
sources/diagramcommands.h
View File

@@ -34,9 +34,9 @@ class DiagramImageItem;
class QetGraphicsItem;
/**
* @brief The AddItemCommand class
* This command add an item in a diagram
* The item to add is template, but must be QGraphicsItem or derived.
@brief The AddItemCommand class
This command add an item in a diagram
The item to add is template, but must be QGraphicsItem or derived.
*/
template <typename QGI>
class AddItemCommand : public QUndoCommand {

10
sources/properties/terminaldata.h
View File

@@ -9,10 +9,12 @@
class QGraphicsObject;
/*!
* \brief The TerminalData class
* Data of the terminal. Stored in extra class so it can be used by PartTerminal and Terminal without
* defining everything again.
/**
@brief The TerminalData class
Data of the terminal.
Stored in extra class so it can be used by PartTerminal
and Terminal without defining everything again.
@note tis class needs to be work on
*/
class TerminalData : public PropertiesInterface
{

89
sources/qetgraphicsitem/terminal.cpp
View File

@@ -185,16 +185,16 @@ Qet::Orientation Terminal::orientation() const {
/**
* @brief Terminal::setNumber
* @param number
@brief Terminal::setNumber
@param number
*/
void Terminal::setNumber(QString number) {
number_terminal_ = std::move(number);
}
/**
* @brief Terminal::setName
* @param name
@brief Terminal::setName
@param name
*/
void Terminal::setName(QString name, bool hiddenName) {
name_terminal_ = std::move(name);
@@ -202,10 +202,10 @@ void Terminal::setName(QString name, bool hiddenName) {
}
/**
* @brief Terminal::addConductor
* Add a conductor to this terminal
* @param conductor : the conductor to add.
* @return true if the conductor was successfully added
@brief Terminal::addConductor
Add a conductor to this terminal
@param conductor : the conductor to add.
@return true if the conductor was successfully added
*/
bool Terminal::addConductor(Conductor *conductor)
{
@@ -227,9 +227,9 @@ bool Terminal::addConductor(Conductor *conductor)
}
/**
* @brief Terminal::removeConductor
* Remove a conductor from this terminal
* @param conductor : conductor to remove
@brief Terminal::removeConductor
Remove a conductor from this terminal
@param conductor : conductor to remove
*/
void Terminal::removeConductor(Conductor *conductor)
{
@@ -346,9 +346,9 @@ void Terminal::paint(QPainter *p, const QStyleOptionGraphicsItem *options, QWidg
}
/**
* @brief Terminal::drawHelpLine
* @param draw : true, display the help line
* false, hide it.
@brief Terminal::drawHelpLine
@param draw : true, display the help line
false, hide it.
*/
void Terminal::drawHelpLine(bool draw)
{
@@ -372,10 +372,10 @@ void Terminal::drawHelpLine(bool draw)
}
/**
* @brief Terminal::HelpLine
* @return a line with coordinate P1 the dock point of conductor
* and P2 the border of diagram, according to the orientation of terminal
* The line is in scene coordinate;
@brief Terminal::HelpLine
@return a line with coordinate P1 the dock point of conductor
and P2 the border of diagram, according to the orientation of terminal
The line is in scene coordinate;
*/
QLineF Terminal::HelpLine() const
{
@@ -425,11 +425,11 @@ QRectF Terminal::boundingRect() const {
}
/**
* @brief Terminal::alignedWithTerminal
* If this terminal is aligned with an other terminal
* and is orientation is opposed return the other terminal
* else return nullptr
* @return
@brief Terminal::alignedWithTerminal
If this terminal is aligned with an other terminal
and is orientation is opposed return the other terminal
else return nullptr
@return
*/
Terminal* Terminal::alignedWithTerminal() const
{
@@ -542,7 +542,6 @@ void Terminal::mouseMoveEvent(QGraphicsSceneMouseEvent *e) {
previous_terminal_ -> update();
}
Diagram *diag = diagram();
if (!diag) return;
// si la scene est un Diagram, on actualise le poseur de conducteur
@@ -584,8 +583,8 @@ void Terminal::mouseMoveEvent(QGraphicsSceneMouseEvent *e) {
/**
* @brief Terminal::mouseReleaseEvent
* @param e
@brief Terminal::mouseReleaseEvent
@param e
*/
void Terminal::mouseReleaseEvent(QGraphicsSceneMouseEvent *e)
{
@@ -658,8 +657,8 @@ void Terminal::mouseReleaseEvent(QGraphicsSceneMouseEvent *e)
}
/**
* @brief Terminal::updateConductor
* Update the path of conductor docked to this terminal
@brief Terminal::updateConductor
Update the path of conductor docked to this terminal
*/
void Terminal::updateConductor() {
foreach (Conductor *conductor, conductors_)
@@ -685,14 +684,14 @@ bool Terminal::isLinkedTo(Terminal *other_terminal) {
}
/**
* @brief Terminal::canBeLinkedTo
* Checking if the terminal can be linked to \p other_terminal or not
* Reasons for not linable:
* - \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,
* otherwise false
@brief Terminal::canBeLinkedTo
Checking if the terminal can be linked to \p other_terminal or not
Reasons for not linable:
- \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,
otherwise false
*/
bool Terminal::canBeLinkedTo(Terminal *other_terminal)
{
@@ -815,15 +814,15 @@ QUuid Terminal::uuid() const {
}
/**
* @brief Conductor::relatedPotentialTerminal
* Return terminal at the same potential from the same
* parent element of @t.
* For folio report, return the terminal of linked other report.
* For Terminal element, return the other terminal of terminal element.
* @param t terminal to start search
* @param all_diagram :if true return all related terminal,
* false return only terminal in the same diagram of @t
* @return the list of terminal at the same potential
@brief Conductor::relatedPotentialTerminal
Return terminal at the same potential from the same
parent element of @t.
For folio report, return the terminal of linked other report.
For Terminal element, return the other terminal of terminal element.
@param t terminal to start search
@param all_diagram :if true return all related terminal,
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)
{

8
sources/qetgraphicsitem/terminal.h
View File

@@ -129,9 +129,11 @@ class Terminal : public QGraphicsObject
QPointF dock_elmt_;
/// List of conductors attached to the terminal
QList<Conductor *> conductors_;
/// Pointer to a rectangle representing the terminal bounding rect;
/// used to calculate the bounding rect once only;
/// used a pointer because boundingRect() is supposed to be const.
/**
Pointer to a rectangle representing the terminal bounding rect;
used to calculate the bounding rect once only;
used a pointer because boundingRect() is supposed to be const.
*/
QRectF *br_{nullptr};
/// Last terminal seen through an attached conductor
Terminal *previous_terminal_;

4
sources/qetgraphicsitem/terminalelement.cpp
View File

@@ -32,8 +32,8 @@ TerminalElement::TerminalElement(const ElementsLocation &location, QGraphicsItem
TerminalElement::~TerminalElement() {}
/**
* @brief TerminalElement::initLink
* @param project
@brief TerminalElement::initLink
@param project
*/
void TerminalElement::initLink(QETProject *project) {
Element::initLink(project);

33
sources/utils/conductorcreator.cpp
View File

@@ -28,10 +28,11 @@
#include <QPolygonF>
/**
* @brief ConductorCreator::ConductorCreator
* Create an electrical potential between all terminals of @terminals_list.
* the terminals of the list must be in the same diagram.
* @param terminals_list
@brief ConductorCreator::ConductorCreator
Create an electrical potential between all terminals of @terminals_list.
the terminals of the list must be in the same diagram.
@param d Diagram
@param terminals_list QList<Terminal *>
*/
ConductorCreator::ConductorCreator(Diagram *d, QList<Terminal *> terminals_list) :
m_terminals_list(terminals_list)
@@ -68,10 +69,10 @@ ConductorCreator::ConductorCreator(Diagram *d, QList<Terminal *> terminals_list)
}
/**
* @brief ConductorCreator::create
* Create an electrical potential between the terminals of the diagram d, contained in the polygon
* @param d
* @param polygon : polygon in diagram coordinate
@brief ConductorCreator::create
Create an electrical potential between the terminals of the diagram d, contained in the polygon
@param d Diagram
@param polygon : polygon in diagram coordinate
*/
void ConductorCreator::create(Diagram *d, const QPolygonF &polygon)
{
@@ -92,8 +93,8 @@ void ConductorCreator::create(Diagram *d, const QPolygonF &polygon)
}
/**
* @brief ConductorCreator::propertieToUse
* @return the conductor properties to use for the new conductors.
@brief ConductorCreator::propertieToUse
@return the conductor properties to use for the new conductors.
*/
void ConductorCreator::setUpPropertieToUse()
{
@@ -130,10 +131,10 @@ void ConductorCreator::setUpPropertieToUse()
}
/**
* @brief ConductorCreator::existingPotential
* Return the list of existing potential of
* the terminal list
* @return
@brief ConductorCreator::existingPotential
Return the list of existing potential of
the terminal list
@return c_list QList<Conductor *>
*/
QList<Conductor *> ConductorCreator::existingPotential()
{
@@ -174,8 +175,8 @@ QList<Conductor *> ConductorCreator::existingPotential()
}
/**
* @brief ConductorCreator::hubTerminal
* @return
@brief ConductorCreator::hubTerminal
@return hub_terminal
*/
Terminal *ConductorCreator::hubTerminal()
{

4
sources/utils/macosxopenevent.h
View File

@@ -19,7 +19,9 @@
#define MACOSXOPENEVENT_H
#include <QObject>
/**
@brief The MacOSXOpenEvent class
*/
class MacOSXOpenEvent : public QObject
{
Q_OBJECT

2
sources/utils/qetutils.h
View File

@@ -21,7 +21,7 @@
#include <QMargins>
/**
* Provide some small utils function
Provide some small utils function
*/
namespace QETUtils
{