mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-04-05 17:35:34 +08:00
Doxygen comments
This commit is contained in:
committed by
Mat Sutcliffe
parent
22cedfe710
commit
46f69217c0
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user