flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-04-12 07:15:34 +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

8
src/blackmisc/network/authenticateduser.h
View File

@@ -130,16 +130,16 @@ namespace BlackMisc
//! Enabled
bool isEnabled() const { return this->m_enabled; }
//! \copydoc CValueObject::toIcon()
//! \copydoc BlackMisc::Mixin::Icon::toIcon()
BlackMisc::CIcon toIcon() const;
//! \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);
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! From our database JSON format

10
src/blackmisc/network/client.h
View File

@@ -111,22 +111,22 @@ namespace BlackMisc
//! Model
const BlackMisc::Simulation::CAircraftModel &getAircraftModel() const { return this->m_model; }
//! \copydoc CAircraftModel::hasQueriedModelString
//! \copydoc Simulation::CAircraftModel::hasQueriedModelString
bool hasQueriedModelString() const { return this->m_model.hasQueriedModelString(); }
//! Set model
void setAircraftModel(const BlackMisc::Simulation::CAircraftModel &model) { this->m_model = model; }
//! \copydoc CValueObject::toIcon()
//! \copydoc BlackMisc::Mixin::Icon::toIcon()
CIcon toIcon() const { return this->m_user.toIcon(); }
//! \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);
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

6
src/blackmisc/network/role.h
View File

@@ -54,13 +54,13 @@ namespace BlackMisc
//! Description
void setDescription(const QString &description) { m_description = description.trimmed(); }
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! \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);
//! Role from DB JSON

6
src/blackmisc/network/server.h
View File

@@ -97,13 +97,13 @@ namespace BlackMisc
//! Validate, provide details about issues
BlackMisc::CStatusMessageList validate() const;
//! \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);
//! \copydoc CValueObject::convertToQString()
//! \copydoc BlackMisc::Mixin::String::toQString()
QString convertToQString(bool i18n = false) const;
private:

6
src/blackmisc/network/textmessage.h
View File

@@ -153,13 +153,13 @@ namespace BlackMisc
//! As pixmap, required for most GUI views
QPixmap toPixmap() const;
//! \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);
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

6
src/blackmisc/network/url.h
View File

@@ -122,13 +122,13 @@ namespace BlackMisc
//! Switch protocol
CUrl withSwitchedScheme(const QString &protocol, int port) const;
//! \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);
//! \copydoc CValueObject::convertToQString()
//! \copydoc BlackMisc::Mixin::String::toQString()
QString convertToQString(bool i18n = false) const;
//! \copydoc BlackMisc::Mixin::JsonByTuple::toJson

8
src/blackmisc/network/user.h
View File

@@ -113,13 +113,13 @@ namespace BlackMisc
//! Set associated callsign
void setCallsign(const BlackMisc::Aviation::CCallsign &callsign);
//! \copydoc CValueObject::toIcon()
//! \copydoc BlackMisc::Mixin::Icon::toIcon()
BlackMisc::CIcon toIcon() const { return this->getCallsign().toIcon(); }
//! \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 by index
@@ -137,7 +137,7 @@ namespace BlackMisc
//! Beautify real name, e.g. "JOE DoE" -> "Joe Doe";
static QString beautifyRealName(const QString &realName);
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

4
src/blackmisc/network/voicecapabilities.h
View File

@@ -51,7 +51,7 @@ namespace BlackMisc
//! Is capability known
bool isUnknown() const { return m_voiceCapabilities == Unknown; }
//! \copydoc CValueObject::toIcon()
//! \copydoc BlackMisc::Mixin::Icon::toIcon()
CIcon toIcon() const;
//! From enum
@@ -66,7 +66,7 @@ namespace BlackMisc
//! All capabilities as list
static const QList<CVoiceCapabilities> &allCapabilities();
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

2
src/blackmisc/network/webdataservicesprovider.cpp
View File

@@ -261,7 +261,7 @@ namespace BlackMisc
return this->m_webDataReaderProvider->getMetarForAirport(icao);
}
int CWebDataServicesAware::getMetarCount() const
int CWebDataServicesAware::getMetarsCount() const
{
Q_ASSERT_X(this->m_webDataReaderProvider, Q_FUNC_INFO, "Missing provider");
if (!hasProvider()) { return 0; }

2
src/blackmisc/network/webdataservicesprovider.h
View File

@@ -345,8 +345,8 @@ namespace BlackMisc
//! \copydoc IWebDataServicesProvider::getMetars
BlackMisc::Weather::CMetarSet getMetars() const;
//! \copydoc IWebDataServicesProvider::getMetarCount
int getMetarCount() const;
//! \copydoc IWebDataServicesProvider::getMetarsCount
//! \copydoc IWebDataServicesProvider::updateWithVatsimDataFileData
void updateWithVatsimDataFileData(BlackMisc::Simulation::CSimulatedAircraft &aircraftToBeUdpated) const;