Doxygen comments

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

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

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

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

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

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

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

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