Fix some doxygen issues

This commit is contained in:
Simon De Backer
2020-08-19 17:31:02 +02:00
parent 5dd57cf003
commit f5725531c2
4 changed files with 18 additions and 6 deletions

View File

@@ -176,9 +176,14 @@ void SingleLineProperties::drawNeutral(QPainter *painter,
} }
/** /**
Draw the PEN (Protective Earth Neutral) symbol using \a painter at position \a @brief SingleLineProperties::drawPen
center, using a size hint of \a size. Draw the PEN (Protective Earth Neutral) symbol using
@param direction Indicate the direction of the underlying conductor segment \a painter at position \a center, using a size hint of \a size.
@param painter
@param direction :
Indicate the direction of the underlying conductor segment
@param center
@param size
*/ */
void SingleLineProperties::drawPen(QPainter *painter, void SingleLineProperties::drawPen(QPainter *painter,
QET::ConductorSegmentType direction, QET::ConductorSegmentType direction,

View File

@@ -35,9 +35,9 @@
/** /**
@brief NewDiagramPage::NewDiagramPage @brief NewDiagramPage::NewDiagramPage
Default constructor Default constructor
@param project, If project, edit the propertie of Project @param project : QETProject
else edit the properties by default of QElectroTech @param parent : QWidget
@param parent, parent widget @param ppd : ProjectPropertiesDialog
*/ */
NewDiagramPage::NewDiagramPage(QETProject *project, NewDiagramPage::NewDiagramPage(QETProject *project,
QWidget *parent, QWidget *parent,

View File

@@ -32,6 +32,7 @@ class QETProject;
class TitleBlockProperties; class TitleBlockProperties;
/** /**
@brief The NewDiagramPage class
This configuration page enables users to define the properties of new This configuration page enables users to define the properties of new
diagrams to come. diagrams to come.
*/ */
@@ -72,6 +73,7 @@ public slots:
}; };
/** /**
@brief The ExportConfigPage class
This configuration page enables users to set default export options. This configuration page enables users to set default export options.
*/ */
class ExportConfigPage : public ConfigPage { class ExportConfigPage : public ConfigPage {
@@ -95,6 +97,7 @@ class ExportConfigPage : public ConfigPage {
}; };
/** /**
@brief The PrintConfigPage class
This configuration page enables users to set default printing options. This configuration page enables users to set default printing options.
*/ */
class PrintConfigPage : public ConfigPage { class PrintConfigPage : public ConfigPage {

View File

@@ -242,12 +242,16 @@ bool QET::attributeIsAReal(const QDomElement &e,
} }
/** /**
@brief QET::ElementsAndConductorsSentence
Permet de composer rapidement la proposition "x elements et y conducteurs" Permet de composer rapidement la proposition "x elements et y conducteurs"
ou encore "x elements, y conducteurs et z champs de texte". ou encore "x elements, y conducteurs et z champs de texte".
@param elements_count nombre d'elements @param elements_count nombre d'elements
@param conductors_count nombre de conducteurs @param conductors_count nombre de conducteurs
@param texts_count nombre de champs de texte @param texts_count nombre de champs de texte
@param images_count nombre d'images @param images_count nombre d'images
@param shapes_count
@param element_text_count
@param tables_count
@return la proposition decrivant le nombre d'elements, de conducteurs et de @return la proposition decrivant le nombre d'elements, de conducteurs et de
textes textes
*/ */