flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-03-22 14:55:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen comments

Browse Source
This commit is contained in:
Klaus Basan
2019-03-21 15:28:26 +01:00
committed by Mat Sutcliffe
parent 22cedfe710
commit 46f69217c0
21 changed files with 71 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/blackcore/application/applicationsettings.h
View File

@@ -29,7 +29,7 @@ namespace BlackCore
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "application/actionhotkeys"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Hotkeys"); return name; }
//! \copydoc BlackMisc::TSettingTrait::isValid
@@ -48,13 +48,13 @@ namespace BlackCore
//! Selected simulator plugins
struct TEnabledSimulators : public BlackMisc::TSettingTrait<QStringList>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "application/enabledsimulators"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Enabled simulators"); return name; }
//! \copydoc BlackCore::TSettingTrait::defaultValue
//! \copydoc BlackMisc::TSettingTrait::defaultValue
static const QStringList &defaultValue()
{
// All default simulators
@@ -62,7 +62,7 @@ namespace BlackCore
return enabledSimulators;
}
//! \copydoc BlackCore::TSettingTrait::isValid
//! \copydoc BlackMisc::TSettingTrait::isValid
static bool isValid(const QStringList &pluginIdentifiers)
{
for (const QString &pluginIdentifier : pluginIdentifiers)
@@ -83,7 +83,7 @@ namespace BlackCore
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "application/crashdump"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Crash dumps"); return name; }
//! \copydoc BlackMisc::TSettingTrait::defaultValue

4
src/blackcore/audio/audiosettings.h
View File

@@ -24,7 +24,7 @@ namespace BlackCore
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "audio/inputdevice"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Input device"); return name; }
};
@@ -34,7 +34,7 @@ namespace BlackCore
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "audio/outputdevice"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Output device"); return name; }
};
} // ns

26
src/blackcore/vatsim/vatsimsettings.h
View File

@@ -86,13 +86,13 @@ namespace BlackCore
//! Reader settings
struct TVatsimBookings : public BlackMisc::TSettingTrait<CReaderSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "vatsimreaders/bookings"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("VATSIM bookings"); return name; }
//! \copydoc BlackCore::TSettingTrait::defaultValue
//! \copydoc BlackMisc::TSettingTrait::defaultValue
static const BlackCore::Vatsim::CReaderSettings &defaultValue()
{
static const BlackCore::Vatsim::CReaderSettings reader {{30.0, BlackMisc::PhysicalQuantities::CTimeUnit::s()}, {120.0, BlackMisc::PhysicalQuantities::CTimeUnit::s()}};
@@ -103,13 +103,13 @@ namespace BlackCore
//! Reader settings
struct TVatsimDataFile : public BlackMisc::TSettingTrait<CReaderSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "vatsimreaders/datafile"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("VATSIM data file"); return name; }
//! \copydoc BlackCore::TSettingTrait::defaultValue
//! \copydoc BlackMisc::TSettingTrait::defaultValue
static const BlackCore::Vatsim::CReaderSettings &defaultValue()
{
static const BlackCore::Vatsim::CReaderSettings reader {{25.0, BlackMisc::PhysicalQuantities::CTimeUnit::s()}, {120.0, BlackMisc::PhysicalQuantities::CTimeUnit::s()}};
@@ -120,13 +120,13 @@ namespace BlackCore
//! Reader settings
struct TVatsimMetars : public BlackMisc::TSettingTrait<CReaderSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "vatsimreaders/metars"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("VATSIM METARs"); return name; }
//! \copydoc BlackCore::TSettingTrait::defaultValue
//! \copydoc BlackMisc::TSettingTrait::defaultValue
static const BlackCore::Vatsim::CReaderSettings &defaultValue()
{
static const BlackCore::Vatsim::CReaderSettings reader {{35.0, BlackMisc::PhysicalQuantities::CTimeUnit::s()}, {300.0, BlackMisc::PhysicalQuantities::CTimeUnit::s()}};
@@ -195,20 +195,20 @@ namespace BlackCore
//! Raw FSD message settings
struct TRawFsdMessageSetting : public BlackMisc::TSettingTrait<CRawFsdMessageSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "network/rawfsdmessagelog"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("FSD message Logging"); return name; }
/* //! \copydoc BlackCore::TSettingTrait::isValid
/* //! \copydoc BlackMisc::TSettingTrait::isValid
static bool isValid(const CRawFsdMessageSettings &setting)
{
if (setting.areRawFsdMessagesEnabled()) { return !setting.getFileDir().isEmpty(); }
return true;
}*/
//! \copydoc BlackCore::TSettingTrait::defaultValue
//! \copydoc BlackMisc::TSettingTrait::defaultValue
static const CRawFsdMessageSettings &defaultValue()
{
static const CRawFsdMessageSettings setting { false, BlackMisc::CDirectoryUtils::logDirectory() };

4
src/blackgui/settings/atcstationssettings.h
View File

@@ -77,10 +77,10 @@ namespace BlackGui
//! ATC stations settings
struct TAtcStationsSettings : public BlackMisc::TSettingTrait<CAtcStationsSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "atcstations"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("ATC stations"); return name; }
};
} // ns

4
src/blackgui/settings/dockwidgetsettings.h
View File

@@ -124,10 +124,10 @@ namespace BlackGui
//! (of the parent object using this setting). If the object name is not set, it will not work correctly
struct TDockWidget : public BlackMisc::TSettingTrait<CDockWidgetSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "guidockwidget/%Application%/%OwnerName%"; } // Key in data cache https://dev.vatsim-germany.org/issues/776
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Dockable widgets"); return name; }
};
} // ns

12
src/blackgui/settings/guisettings.h
View File

@@ -75,26 +75,26 @@ namespace BlackGui
//! General GUI settings
struct TGeneralGui : public BlackMisc::TSettingTrait<CGeneralGuiSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "guigeneral"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("General GUI"); return name; }
};
//! Settings for last manual entries of own aircraft mode
struct TBackgroundConsolidation : public BlackMisc::TSettingTrait<int>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "backgroundconsolidation"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Background consolidation"); return name; }
//! \copydoc BlackCore::TSettingTrait::isValid
//! \copydoc BlackMisc::TSettingTrait::isValid
static bool isValid(const int &valueInSeconds) { return valueInSeconds == -1 || (valueInSeconds >= minSecs() && valueInSeconds <= maxSecs()); }
//! \copydoc BlackCore::TSettingTrait::defaultValue
//! \copydoc BlackMisc::TSettingTrait::defaultValue
static const int &defaultValue() { static const int i = 60; return i; }
//! Minimum

4
src/blackgui/settings/navigatorsettings.h
View File

@@ -100,10 +100,10 @@ namespace BlackGui
//! Trait for settings for navigator
struct TNavigator : public BlackMisc::TSettingTrait<CNavigatorSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "guinavigator"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Navigator"); return name; }
};
} // ns

4
src/blackgui/settings/textmessagesettings.h
View File

@@ -131,10 +131,10 @@ namespace BlackGui
//! Text message settings
struct TextMessageSettings : public BlackMisc::TSettingTrait<CTextMessageSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "textmessages"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Text message"); return name; }
};
} // ns

6
src/blackgui/settings/updatenotification.h
View File

@@ -21,13 +21,13 @@ namespace BlackGui
//! Trait for directory settings
struct TUpdateNotificationSettings : public BlackMisc::TSettingTrait<bool>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "guiupdatenotification/%Application%"; }
//! \copydoc BlackCore::TSettingTrait::defaultValue
//! \copydoc BlackMisc::TSettingTrait::defaultValue
static const bool &defaultValue() { static const bool d = true; return d; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Update notification"); return name; }
};
} // ns

6
src/blackgui/settings/viewupdatesettings.h
View File

@@ -99,13 +99,13 @@ namespace BlackGui
//! Trait for settings about update rates
struct TViewUpdateSettings : public BlackMisc::TSettingTrait<CViewUpdateSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "guiviewupdate"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("View update"); return name; }
//! \copydoc BlackCore::TSettingTrait::isValid
//! \copydoc BlackMisc::TSettingTrait::isValid
static bool isValid(const CViewUpdateSettings &settings) { return settings.isValid(); }
};
} // ns

2
src/blackmisc/audio/audiosettings.h
View File

@@ -79,7 +79,7 @@ namespace BlackMisc
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "audio/setup"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Audio"); return name; }
//! \copydoc BlackMisc::TSettingTrait::isValid

4
src/blackmisc/audio/settings/voicesettings.h
View File

@@ -27,10 +27,10 @@ namespace BlackMisc
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "audio/currentvoicesetup"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Voice setup"); return name; }
//! \copydoc BlackCore::TSettingTrait::isValid
//! \copydoc BlackMisc::TSettingTrait::isValid
static bool isValid(const CVoiceSetup &setup) { return setup.validate().isSuccess(); }
};
} // ns

4
src/blackmisc/directories.h
View File

@@ -120,10 +120,10 @@ namespace BlackMisc
//! ATC stations settings
struct TDirectorySettings : public TSettingTrait<CDirectories>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "swiftdirectories"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("swift directories"); return name; }
};
}

2
src/blackmisc/network/settings/serversettings.h
View File

@@ -29,7 +29,7 @@ namespace BlackMisc
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "network/trafficservers"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Traffic servers"); return name; }
};

4
src/blackmisc/simulation/data/lastmodel.h
View File

@@ -23,10 +23,10 @@ namespace BlackMisc
//! Last model used
struct TLastModel : public BlackMisc::TDataTrait<CAircraftModel>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "lastaircraftmodel"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Own aircraft model"); return name; }
};
} // ns

4
src/blackmisc/simulation/settings/interpolationrenderingsetupsettings.h
View File

@@ -23,10 +23,10 @@ namespace BlackMisc
//! Last model used
struct TInterpolationAndRenderingSetupGlobal : public TSettingTrait<CInterpolationAndRenderingSetupGlobal>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "settingsglobalinterpolationsetup"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Interpolation setup"); return name; }
};
} // ns

2
src/blackmisc/simulation/settings/modelmatchersettings.h
View File

@@ -26,7 +26,7 @@ namespace BlackMisc
//! Key in data cache
static const char *key() { return "matching"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Model matching"); return name; }
};
} // ns

4
src/blackmisc/simulation/settings/modelsettings.h
View File

@@ -65,14 +65,14 @@ namespace BlackMisc
//! Key in data cache
static const char *key() { return "Models"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Model settings"); return name; }
};
//! Mapping preferences for model distributor list
struct TDistributorListPreferences : public TSettingTrait<Simulation::CDistributorListPreferences>
{
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Distributor preferences"); return name; }
//! \copydoc BlackMisc::TSettingTrait::key

26
src/blackmisc/simulation/settings/simulatorsettings.h
View File

@@ -206,30 +206,30 @@ namespace BlackMisc
//! Trait for simulator settings
struct TSimulatorFsx : public TSettingTrait<CSimulatorSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "settingssimulatorfsx"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("FSX settings"); return name; }
};
//! Trait for simulator settings
struct TSimulatorFs9 : public TSettingTrait<CSimulatorSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "settingssimulatorfs9"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("FS9 settings"); return name; }
};
//! Trait for simulator settings
struct TSimulatorP3D : public TSettingTrait<CSimulatorSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "settingssimulatorp3d"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("P3D settings"); return name; }
};
@@ -239,7 +239,7 @@ namespace BlackMisc
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "simulator/p3dversion"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("P3D version"); return name; }
//! \copydoc BlackMisc::TSettingTrait::defaultValue
@@ -253,20 +253,20 @@ namespace BlackMisc
//! Trait for simulator settings
struct TSimulatorXP : public TSettingTrait<CSimulatorSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "settingssimulatorxplane"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("XPlane settings"); return name; }
};
//! Trait for simulator settings
struct TSimulatorFG : public TSettingTrait<CSimulatorSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "settingssimulatorfg"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("FG settings"); return name; }
};
@@ -468,7 +468,7 @@ namespace BlackMisc
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "settingssimulatormessages"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Simulator messages"); return name; }
};
@@ -478,7 +478,7 @@ namespace BlackMisc
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "simulator/selectedweatherscenario"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Weather scenario"); return name; }
//! \copydoc BlackMisc::TSettingTrait::defaultValue

6
src/blackmisc/simulation/settings/swiftpluginsettings.h
View File

@@ -91,13 +91,13 @@ namespace BlackMisc
//! Trait for swift plugin settings
struct TSwiftPlugin : public BlackMisc::TSettingTrait<CSwiftPluginSettings>
{
//! \copydoc BlackCore::TSettingTrait::key
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "settingsswiftplugin"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("swift plugin"); return name; }
//! \copydoc BlackCore::TSettingTrait::isValid
//! \copydoc BlackMisc::TSettingTrait::isValid
static bool isValid(const CSwiftPluginSettings &value) { return value.getEmulatedSimulator().isSingleSimulator(); }
};
} // ns

2
src/blackmisc/simulation/settings/xswiftbussettings.h
View File

@@ -29,7 +29,7 @@ namespace BlackMisc
//! \copydoc BlackMisc::TSettingTrait::key
static const char *key() { return "xswiftbus/server"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
//! \copydoc BlackMisc::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("XSwiftBus"); return name; }
//! \copydoc BlackMisc::TSettingTrait::defaultValue