mirror of
https://github.com/qelectrotech/qelectrotech-source-mirror.git
synced 2025-12-17 12:40:35 +01:00
Add documentation + wrap code for better readability
This commit is contained in:
Simon De Backer
committed by
Laurent Trinques
Laurent Trinques
parent
70ef559874
commit
495d9a5f51
@@ -27,7 +27,7 @@
|
||||
- 17 columns of 60.0 px wide by 20.0px high
|
||||
- 8 lines of 80.0 px high by 20.0px wide
|
||||
|
||||
Initialise un objet BorderProperties avec les proprietes par
|
||||
\~French Initialise un objet BorderProperties avec les proprietes par
|
||||
defaut suivantes :
|
||||
- 17 colonnes affichees de 60.0 px de large pour 20.0px de haut
|
||||
- 8 lignes affichees de 80.0 px de haut pour 20.0px de large
|
||||
@@ -53,12 +53,11 @@ BorderProperties::~BorderProperties() {
|
||||
|
||||
/**
|
||||
@brief BorderProperties::operator ==
|
||||
@param bp :
|
||||
- other BorderProperties container/class
|
||||
- autre conteneur BorderProperties
|
||||
@return
|
||||
- true if it and this container are identical, false otherwise
|
||||
- true si ip et ce conteneur sont identiques, false sinon
|
||||
|
||||
\~ @param bp : Other BorderProperties container/class.
|
||||
\~French Autre conteneur BorderProperties
|
||||
\~ @return True if it and this container are identical, false otherwise.
|
||||
\~French True si ip et ce conteneur sont identiques, false sinon
|
||||
*/
|
||||
bool BorderProperties::operator==(const BorderProperties &bp) {
|
||||
return(
|
||||
@@ -75,12 +74,13 @@ bool BorderProperties::operator==(const BorderProperties &bp) {
|
||||
|
||||
/**
|
||||
@brief BorderProperties::operator !=
|
||||
@param bp :
|
||||
- other BorderProperties container/class
|
||||
- autre conteneur BorderProperties
|
||||
@return
|
||||
- false if it and this container are identical, true otherwise
|
||||
- false si bp et ce conteneur sont identiques, true sinon
|
||||
|
||||
\~ @param bp :
|
||||
Other BorderProperties container/class.
|
||||
\~French Autre conteneur BorderProperties
|
||||
\~ @return
|
||||
False if it and this container are identical, true otherwise.
|
||||
\~French False si bp et ce conteneur sont identiques, true sinon
|
||||
*/
|
||||
bool BorderProperties::operator!=(const BorderProperties &bp) {
|
||||
return(!(*this == bp));
|
||||
@@ -88,11 +88,12 @@ bool BorderProperties::operator!=(const BorderProperties &bp) {
|
||||
|
||||
/**
|
||||
@brief BorderProperties::toXml
|
||||
- Exports dimensions as XML attributes added to element e.
|
||||
- Exporte les dimensions sous formes d'attributs XML ajoutes a l'element e.
|
||||
@param e :
|
||||
- XML element to which attributes will be added
|
||||
- Element XML auquel seront ajoutes des attributs
|
||||
Exports dimensions as XML attributes added to element e.
|
||||
\~French Exporte les dimensions sous formes d'attributs XML ajoutes a l'element e.
|
||||
|
||||
\~ @param e :
|
||||
XML element to which attributes will be added
|
||||
\~French Element XML auquel seront ajoutes des attributs
|
||||
*/
|
||||
void BorderProperties::toXml(QDomElement &e) const {
|
||||
e.setAttribute("cols", columns_count);
|
||||
@@ -105,11 +106,12 @@ void BorderProperties::toXml(QDomElement &e) const {
|
||||
|
||||
/**
|
||||
@brief BorderProperties::fromXml
|
||||
- Import dimensions from XML attributes of element e
|
||||
- Importe les dimensions a partir des attributs XML de l'element e
|
||||
@param e :
|
||||
- XML element whose attributes will be read
|
||||
- Element XML dont les attributs seront lus
|
||||
Import dimensions from XML attributes of element e
|
||||
\~French Importe les dimensions a partir des attributs XML de l'element e
|
||||
|
||||
\~ @param e :
|
||||
XML element whose attributes will be read
|
||||
\~French Element XML dont les attributs seront lus
|
||||
*/
|
||||
void BorderProperties::fromXml(QDomElement &e) {
|
||||
if (e.hasAttribute("cols")) columns_count = e.attribute("cols").toInt();
|
||||
@@ -122,14 +124,15 @@ void BorderProperties::fromXml(QDomElement &e) {
|
||||
|
||||
/**
|
||||
@brief BorderProperties::toSettings
|
||||
- Export dimensions in a QSettings object.
|
||||
- Exporte les dimensions dans une configuration.
|
||||
@param settings :
|
||||
- QSettings object to write
|
||||
- Parametres a ecrire
|
||||
@param prefix :
|
||||
- prefix to be added before the names of the parameters
|
||||
- prefixe a ajouter devant les noms des parametres
|
||||
Export dimensions in a QSettings object.
|
||||
\~French Exporte les dimensions dans une configuration.
|
||||
|
||||
\~ @param settings :
|
||||
QSettings object to write
|
||||
\~French Parametres a ecrire
|
||||
\~ @param prefix :
|
||||
prefix to be added before the names of the parameters
|
||||
\~French prefixe a ajouter devant les noms des parametres
|
||||
*/
|
||||
void BorderProperties::toSettings(QSettings &settings, const QString &prefix) const {
|
||||
settings.setValue(prefix + "cols", columns_count);
|
||||
@@ -142,14 +145,12 @@ void BorderProperties::toSettings(QSettings &settings, const QString &prefix) co
|
||||
|
||||
/**
|
||||
@brief BorderProperties::fromSettings
|
||||
- Import dimensions from a QSettings object.
|
||||
- Importe les dimensions depuis une configuration.
|
||||
@param settings :
|
||||
- QSettings object to read
|
||||
- Parametres a lire
|
||||
@param prefix :
|
||||
- prefix to be added before the names of the parameters
|
||||
- prefixe a ajouter devant les noms des parametres
|
||||
Import dimensions from a QSettings object.
|
||||
\~French Importe les dimensions depuis une configuration.
|
||||
\~ @param settings : QSettings object to read
|
||||
\~French Parametres a lire
|
||||
\~ @param prefix : prefix to be added before the names of the parameters
|
||||
\~French prefixe a ajouter devant les noms des parametres
|
||||
*/
|
||||
void BorderProperties::fromSettings(QSettings &settings, const QString &prefix) {
|
||||
columns_count = settings.value(prefix + "cols", columns_count).toInt();
|
||||
|
||||
Reference in New Issue
Block a user