flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-04-21 12:55:31 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix doxygen copydoc documentation

Browse Source 
The following issues were fixed
* Fixed wrong/missing namespaces
* Fixed obvious typos in documentation
* Documentation not in sync with source code

refs #544
This commit is contained in:
Roland Winklmeier
2016-02-07 18:40:11 +01:00
parent dfb6798d31
commit 794bf0cd74
154 changed files with 399 additions and 399 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/blackmisc/pq/angle.h
View File

@@ -52,7 +52,7 @@ namespace BlackMisc
degrees + minutes / 100.0,
CAngleUnit::sexagesimalDegMin()) {}
//! \copydoc CValueObject::toIcon
//! \copydoc BlackMisc::Mixin::Icon::toIcon
BlackMisc::CIcon toIcon() const;
//! Value as factor of PI (e.g. 0.5PI)

6
src/blackmisc/pq/measurementunit.h
View File

@@ -237,19 +237,19 @@ namespace BlackMisc
//! Destructor
virtual ~CMeasurementUnit() = default;
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const
{
return this->getSymbol(i18n);
}
//! \copydoc CValueObject::marshallToDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::marshallToDbus
void marshallToDbus(QDBusArgument &argument) const
{
argument << this->m_symbol;
}
//! \copydoc CValueObject::unmarshallFromDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::unmarshallFromDbus
void unmarshallFromDbus(const QDBusArgument &)
{
// the concrete implementations will override this default

18
src/blackmisc/pq/physicalquantity.h
View File

@@ -181,40 +181,40 @@ namespace BlackMisc
//! Make value always negative
void makeNegative();
//! \copydoc CValueObject::marshallToDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::marshallToDbus
void marshallToDbus(QDBusArgument &argument) const;
//! \copydoc CValueObject::unmarshallFromDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::unmarshallFromDbus
void unmarshallFromDbus(const QDBusArgument &argument);
//! \copydoc CValueObject::qHash
//! \copydoc BlackMisc::Mixin::HashByTuple::qHash
uint getValueHash() const;
//! \copydoc CValueObject::qHash
friend uint qHash(const PQ &pq) { return pq.getValueHash(); }
//! \copydoc CValueObject::toJson
//! \copydoc BlackMisc::Mixin::JsonByTuple::toJson
QJsonObject toJson() const;
//! \copydoc CValueObject::convertFromJson
//! \copydoc BlackMisc::Mixin::JsonByTuple::convertFromJson
void convertFromJson(const QJsonObject &json);
//! Parse to string, with specified separator
void parseFromString(const QString &value, CPqString::SeparatorMode mode);
//! \copydoc CValueObject::parseFromString
//! Parse value from string
void parseFromString(const QString &value);
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! Compare
int comparePropertyByIndex(const PQ &pq, const CPropertyIndex &index) const;
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
protected:

2
src/blackmisc/pq/pqstring.h
View File

@@ -30,7 +30,7 @@ namespace BlackMisc
class BLACKMISC_EXPORT CPqString : public CValueObject<CPqString>
{
public:
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! Number separators / group separators

18
src/blackmisc/pq/units.h
View File

@@ -144,7 +144,7 @@ namespace BlackMisc
return u;
}
//! \copydoc CValueObject::unmarshallFromDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::unmarshallFromDbus
void unmarshallFromDbus(const QDBusArgument &argument)
{
QString unitName;
@@ -243,7 +243,7 @@ namespace BlackMisc
return u;
}
//! \copydoc CValueObject::unmarshallFromDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::unmarshallFromDbus
void unmarshallFromDbus(const QDBusArgument &argument)
{
QString unitName;
@@ -333,7 +333,7 @@ namespace BlackMisc
return u;
}
//! \copydoc CValueObject::unmarshallFromDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::unmarshallFromDbus
void unmarshallFromDbus(const QDBusArgument &argument)
{
QString unitName;
@@ -432,7 +432,7 @@ namespace BlackMisc
return u;
}
//! \copydoc CValueObject::unmarshallFromDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::unmarshallFromDbus
void unmarshallFromDbus(const QDBusArgument &argument)
{
QString unitName;
@@ -548,7 +548,7 @@ namespace BlackMisc
return u;
}
//! \copydoc CValueObject::unmarshallFromDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::unmarshallFromDbus
void unmarshallFromDbus(const QDBusArgument &argument)
{
QString unitName;
@@ -639,7 +639,7 @@ namespace BlackMisc
return u;
}
//! \copydoc CValueObject::unmarshallFromDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::unmarshallFromDbus
void unmarshallFromDbus(const QDBusArgument &argument)
{
QString unitName;
@@ -748,7 +748,7 @@ namespace BlackMisc
return u;
}
//! \copydoc CValueObject::unmarshallFromDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::unmarshallFromDbus
void unmarshallFromDbus(const QDBusArgument &argument)
{
QString unitName;
@@ -881,7 +881,7 @@ namespace BlackMisc
return u;
}
//! \copydoc CValueObject::unmarshallFromDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::unmarshallFromDbus
void unmarshallFromDbus(const QDBusArgument &argument)
{
QString unitName;
@@ -955,7 +955,7 @@ namespace BlackMisc
return u;
}
//! \copydoc CValueObject::unmarshallFromDbus
//! \copydoc BlackMisc::Mixin::DBusByTuple::unmarshallFromDbus
void unmarshallFromDbus(const QDBusArgument &argument)
{
QString unitName;