mirror of
https://github.com/qelectrotech/qelectrotech-source-mirror.git
synced 2026-03-23 23:59:58 +01:00
Fix various typos in source documentation and comments (cont.)
Found via `codespell`
This commit is contained in:
committed by
Laurent Trinques
parent
a76e5446aa
commit
1994235bc5
@@ -40,7 +40,7 @@ QDomElement ElementData::toXml(QDomDocument &xml_element) const {
|
||||
* The tag name of xml_element must be definition
|
||||
* and have an attribute "type"
|
||||
* @param xml_element : tagName must be 'definition'
|
||||
* @return true is successfuly loaded
|
||||
* @return true is successfully loaded
|
||||
*/
|
||||
bool ElementData::fromXml(const QDomElement &xml_element)
|
||||
{
|
||||
|
||||
@@ -36,7 +36,7 @@ class PropertiesInterface
|
||||
@brief toSettings
|
||||
Save properties to setting file.
|
||||
@param settings : is use for prefix a word
|
||||
befor the name of each paramètre
|
||||
before the name of each parameter
|
||||
@param QString
|
||||
*/
|
||||
virtual void toSettings (QSettings &settings,
|
||||
@@ -45,7 +45,7 @@ class PropertiesInterface
|
||||
@brief fromSettings
|
||||
load properties to setting file.
|
||||
@param settings : is use for prefix a word
|
||||
befor the name of each paramètre
|
||||
before the name of each parameter
|
||||
@param QString
|
||||
*/
|
||||
virtual void fromSettings (const QSettings &settings,
|
||||
|
||||
@@ -53,9 +53,9 @@ void TerminalData::setParent(QGraphicsObject* parent)
|
||||
|
||||
/**
|
||||
@brief TerminalData::toSettings
|
||||
Save properties to setting file.
|
||||
Save properties to settings file.
|
||||
|
||||
QString is use for prefix a word befor the name of each paramètre
|
||||
QString is used to prefix a word before the name of each parameter
|
||||
@param settings UNUSED
|
||||
@param prefix UNUSED
|
||||
*/
|
||||
@@ -68,9 +68,9 @@ void TerminalData::toSettings(QSettings &settings, const QString prefix) const
|
||||
|
||||
/**
|
||||
@brief TerminalData::fromSettings
|
||||
load properties to setting file.
|
||||
load properties to settings file.
|
||||
|
||||
QString is use for prefix a word befor the name of each paramètre
|
||||
QString is used to prefix a word before the name of each parameter
|
||||
@param settings UNUSED
|
||||
@param prefix UNUSED
|
||||
*/
|
||||
@@ -87,7 +87,7 @@ void TerminalData::fromSettings(const QSettings &settings, const QString prefix)
|
||||
to xml_element
|
||||
|
||||
@note This method is only called from the PartTerminal
|
||||
and should never called from the Terminal class
|
||||
and should never be called from the Terminal class
|
||||
@param xml_document
|
||||
@return xml_element : DomElement with
|
||||
the name, number, position and orientation of the terminal
|
||||
@@ -115,7 +115,7 @@ QDomElement TerminalData::toXml(QDomDocument &xml_document) const
|
||||
load properties to xml element
|
||||
|
||||
@note This method is only called from the PartTerminal
|
||||
and should never called from the Terminal class
|
||||
and should never be called from the Terminal class
|
||||
@param xml_element
|
||||
@return true if succeeded / false if the attribute is not real
|
||||
*/
|
||||
|
||||
@@ -68,7 +68,7 @@ QDomElement UserProperties::toXml(QDomDocument &xml_document) const
|
||||
* @brief UserProperties::fromXml
|
||||
* @param xml_element
|
||||
* @return load user properties from xml
|
||||
* Take car befor use this function that the tagName of this class
|
||||
* Take care before using this function that the tagName of this class
|
||||
* is the same as the tag of xml_element given in parameter.
|
||||
*/
|
||||
bool UserProperties::fromXml(const QDomElement &xml_element)
|
||||
|
||||
@@ -163,7 +163,7 @@ bool XRefProperties::fromXml(const QDomElement &xml_element) {
|
||||
/**
|
||||
@brief XRefProperties::defaultProperties
|
||||
@return the default properties stored in the setting file
|
||||
For the xref, there is 2 propreties.
|
||||
For the xref, there are 2 properties.
|
||||
For coil, stored with the string "coil" in the returned QHash.
|
||||
For protection, stored with the string "protection" in the returned QHash.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user