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

@@ -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

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

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() };