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

Fix some doxygen issues

Browse Source
This commit is contained in:
Simon De Backer
2020-08-19 21:24:48 +02:00
parent f5725531c2
commit 666f20856e
21 changed files with 149 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
sources/ElementsCollection/xmlelementcollection.cpp
View File

@@ -326,7 +326,7 @@ QDomElement XmlElementCollection::directory(const QString &path) const
path : import/dir1/dir2/dir3/myElement.elmt
If the path doesn't exist, he was created.
If the element already exist, do nothing.
@param location, location of the element
@param location : location of the element
@return the collection path of the added item
or a null QString if element can't be added.
*/

50
sources/ElementsCollection/xmlelementcollection.h
View File

@@ -67,35 +67,35 @@ class XmlElementCollection : public QObject
ElementsLocation copyElement(ElementsLocation &source, ElementsLocation &destination, const QString& rename = QString());
signals:
/**
@brief elementAdded
This signal is emited when a element is added to this collection
@param collection_path, the path of element in this collection
*/
/**
@brief elementAdded
This signal is emited when a element is added to this collection
@param collection_path : the path of element in this collection
*/
void elementAdded(QString collection_path);
/**
@brief elementChanged
This signal is emited when the defintion of the element at path was changed
@param collection_path, the path of this element in this collection
*/
/**
@brief elementChanged
This signal is emited when the defintion of the element at path was changed
@param collection_path : the path of this element in this collection
*/
void elementChanged (QString collection_path);
/**
@brief elementRemoved
This signal is emited when an element is removed to this collection
@param collection_path, the path of the removed element in this collection
*/
/**
@brief elementRemoved
This signal is emited when an element is removed to this collection
@param collection_path : the path of the removed element in this collection
*/
void elementRemoved(QString collection_path);
/**
@brief directorieAdded
This signal is emited when a directorie is added to this collection
@param collection_path, the path of the new directorie
*/
/**
@brief directorieAdded
This signal is emited when a directorie is added to this collection
@param collection_path : the path of the new directorie
*/
void directorieAdded(QString collection_path);
/**
@brief directoryRemoved
This signal is emited when a directory is removed to this collection
@param collection_path, the path of the removed directory
*/
/**
@brief directoryRemoved
This signal is emited when a directory is removed to this collection
@param collection_path : the path of the removed directory
*/
void directoryRemoved(QString collection_path);
private:

25
sources/ElementsCollection/xmlprojectelementcollectionitem.cpp
View File

@@ -1,19 +1,19 @@
/*
Copyright 2006-2020 The QElectroTech Team
This file is part of QElectroTech.
Copyright 2006-2020 The QElectroTech Team
This file is part of QElectroTech.
QElectroTech is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
QElectroTech is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
QElectroTech is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
QElectroTech is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with QElectroTech. If not, see <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU General Public License
along with QElectroTech. If not, see <http://www.gnu.org/licenses/>.
*/
#include "qetproject.h"
#include "xmlelementcollection.h"
@@ -236,6 +236,7 @@ void XmlProjectElementCollectionItem::setUpIcon()
@brief XmlProjectElementCollectionItem::populate
Create the childs of this item
@param set_data : if true, call setUpData for every child of this item
@param hide_element : bool
*/
void XmlProjectElementCollectionItem::populate(bool set_data, bool hide_element)
{

27
sources/ElementsCollection/xmlprojectelementcollectionitem.h
View File

@@ -1,19 +1,19 @@
/*
Copyright 2006-2020 The QElectroTech Team
This file is part of QElectroTech.
Copyright 2006-2020 The QElectroTech Team
This file is part of QElectroTech.
QElectroTech is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
QElectroTech is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
QElectroTech is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
QElectroTech is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with QElectroTech. If not, see <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU General Public License
along with QElectroTech. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef XMLPROJECTELEMENTCOLLECTIONITEM2_H
#define XMLPROJECTELEMENTCOLLECTIONITEM2_H
@@ -25,7 +25,8 @@ class QETProject;
/**
@brief The XmlProjectElementCollectionItem class
This class specialise ElementCollectionItem for manage an xml collection embedded in a project.
This class specialise ElementCollectionItem
for manage an xml collection embedded in a project.
*/
class XmlProjectElementCollectionItem : public ElementCollectionItem
{