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

Fix some doxygen issues

Browse Source
This commit is contained in:
Simon De Backer
2020-08-17 21:24:20 +02:00
parent 2482a0bd4c
commit b28ca0361d
1 changed files with 25 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
sources/qetproject.cpp
View File

@@ -502,7 +502,7 @@ QHash <QString, NumerotationContext> QETProject::elementAutoNum() const {
/** /**
@brief QETProject::elementAutoNumFormula @brief QETProject::elementAutoNumFormula
@param element autonum title @param key : autonum title
@return Formula of element autonum stored in element autonum @return Formula of element autonum stored in element autonum
*/ */
QString QETProject::elementAutoNumFormula (const QString& key) const QString QETProject::elementAutoNumFormula (const QString& key) const
@@ -532,7 +532,7 @@ QString QETProject::elementCurrentAutoNum () const {
/** /**
@brief QETProject::setCurrrentElementAutonum @brief QETProject::setCurrrentElementAutonum
@param autoNum : set the current element autonum to @autonum @param autoNum : set the current element autonum to autonum
*/ */
void QETProject::setCurrrentElementAutonum(QString autoNum) { void QETProject::setCurrrentElementAutonum(QString autoNum) {
m_current_element_autonum = std::move(autoNum); m_current_element_autonum = std::move(autoNum);
@@ -540,7 +540,7 @@ void QETProject::setCurrrentElementAutonum(QString autoNum) {
/** /**
@brief QETProject::conductorAutoNumFormula @brief QETProject::conductorAutoNumFormula
@param conductor autonum title @param key : autonum title
@return Formula of element autonum stored in conductor autonum @return Formula of element autonum stored in conductor autonum
*/ */
QString QETProject::conductorAutoNumFormula (const QString& key) const QString QETProject::conductorAutoNumFormula (const QString& key) const
@@ -561,7 +561,7 @@ QString QETProject::conductorCurrentAutoNum () const {
/** /**
@brief QETProject::setCurrentConductorAutoNum @brief QETProject::setCurrentConductorAutoNum
@param autoNum set the current conductor autonum to @autonum @param autoNum set the current conductor autonum to autonum
*/ */
void QETProject::setCurrentConductorAutoNum(QString autoNum) { void QETProject::setCurrentConductorAutoNum(QString autoNum) {
m_current_conductor_autonum = std::move(autoNum); m_current_conductor_autonum = std::move(autoNum);
@@ -641,7 +641,7 @@ void QETProject::removeFolioAutoNum(const QString& key) {
/** /**
@brief QETProject::conductorAutoNum @brief QETProject::conductorAutoNum
Return conductor numerotation context stored with @key. Return conductor numerotation context stored with key.
If key is not found, return an empty numerotation context If key is not found, return an empty numerotation context
@param key @param key
*/ */
@@ -652,7 +652,7 @@ NumerotationContext QETProject::conductorAutoNum (const QString &key) const {
/** /**
@brief QETProject::elementAutoNum @brief QETProject::elementAutoNum
Return element numerotation context stored with @key. Return element numerotation context stored with key.
If key is not found, return an empty numerotation context If key is not found, return an empty numerotation context
@param key @param key
*/ */
@@ -663,7 +663,7 @@ NumerotationContext QETProject::elementAutoNum (const QString &key) {
/** /**
@brief QETProject::folioAutoNum @brief QETProject::folioAutoNum
Return folio numerotation context stored with @key. Return folio numerotation context stored with key.
If key is not found, return an empty numerotation context If key is not found, return an empty numerotation context
@param key @param key
*/ */
@@ -803,7 +803,8 @@ void QETProject::autoFolioNumberingSelectedFolios(int from, int to, const QStrin
} }
/** /**
@return un document XML representant le projet @brief QETProject::toXml
@return un document XML representant le projet
*/ */
QDomDocument QETProject::toXml() { QDomDocument QETProject::toXml() {
// racine du projet // racine du projet
@@ -898,6 +899,7 @@ QETResult QETProject::write()
} }
/** /**
@brief QETProject::isReadOnly
@return true si le projet est en mode readonly, false sinon @return true si le projet est en mode readonly, false sinon
*/ */
bool QETProject::isReadOnly() const { bool QETProject::isReadOnly() const {
@@ -906,7 +908,7 @@ bool QETProject::isReadOnly() const {
/** /**
@brief QETProject::setReadOnly @brief QETProject::setReadOnly
Set this project to read only if @read_only = true Set this project to read only if read_only = true
@param read_only @param read_only
*/ */
void QETProject::setReadOnly(bool read_only) void QETProject::setReadOnly(bool read_only)
@@ -943,7 +945,8 @@ bool QETProject::isEmpty() const {
/** /**
@brief QETProject::importElement @brief QETProject::importElement
Import the element represented by @location to the embbeded collection of this project Import the element represented by location
to the embbeded collection of this project
@param location @param location
@return the location of the imported element, location can be null. @return the location of the imported element, location can be null.
*/ */
@@ -1030,10 +1033,13 @@ ElementsLocation QETProject::importElement(ElementsLocation &location)
} }
/** /**
@brief QETProject::integrateTitleBlockTemplate
Integrate a title block template into this project. Integrate a title block template into this project.
@param src_tbt The location of the title block template to be integrated into this project @param src_tbt The location of the title block template
to be integrated into this project
@param handler @param handler
@return the name of the template after integration, or an empty QString if a problem occurred. @return the name of the template after integration,
or an empty QString if a problem occurred.
*/ */
QString QETProject::integrateTitleBlockTemplate(const TitleBlockTemplateLocation &src_tbt, MoveTitleBlockTemplatesHandler *handler) { QString QETProject::integrateTitleBlockTemplate(const TitleBlockTemplateLocation &src_tbt, MoveTitleBlockTemplatesHandler *handler) {
TitleBlockTemplateLocation dst_tbt(src_tbt.name(), &m_titleblocks_collection); TitleBlockTemplateLocation dst_tbt(src_tbt.name(), &m_titleblocks_collection);
@@ -1140,7 +1146,7 @@ Diagram *QETProject::addNewDiagram(int pos)
/** /**
@brief QETProject::removeDiagram @brief QETProject::removeDiagram
Remove @diagram from project Remove diagram from project
@param diagram @param diagram
*/ */
void QETProject::removeDiagram(Diagram *diagram) void QETProject::removeDiagram(Diagram *diagram)
@@ -1470,12 +1476,12 @@ void QETProject::writeProjectPropertiesXml(QDomElement &xml_element) {
/** /**
@brief QETProject::writeDefaultPropertiesXml @brief QETProject::writeDefaultPropertiesXml
Export all defaults properties used by a new diagram and his content Export all defaults properties used by a new diagram and his content
#size of border size of border
#content of titleblock content of titleblock
#default conductor default conductor
#defaut folio report defaut folio report
#default Xref default Xref
@param xml_element xml element to use for store default propertie. @param xml_element : xml element to use for store default propertie.
*/ */
void QETProject::writeDefaultPropertiesXml(QDomElement &xml_element) void QETProject::writeDefaultPropertiesXml(QDomElement &xml_element)
{ {