flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-04-28 11:45:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated some documentation based on a brief slack discussion with MG

Browse Source
This commit is contained in:
Klaus Basan
2016-10-29 00:32:01 +02:00
parent 0fd0ce05f0
commit c02cbcb952
3 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/blackcore/data/globalsetup.h
View File

@@ -31,6 +31,7 @@ namespace BlackCore
namespace Data namespace Data
{ {
//! Global settings for readers, debug flags, etc. //! Global settings for readers, debug flags, etc.
//! \note also called the bootstrap file as it is needed once to get information where all the data are located
class BLACKCORE_EXPORT CGlobalSetup : class BLACKCORE_EXPORT CGlobalSetup :
public BlackMisc::CValueObject<CGlobalSetup>, public BlackMisc::CValueObject<CGlobalSetup>,
public BlackMisc::ITimestampBased public BlackMisc::ITimestampBased

6
src/blackcore/setupreader.cpp
View File

@@ -39,7 +39,7 @@ namespace BlackCore
m_cmdBootstrapUrl m_cmdBootstrapUrl
{ {
{ "url", "bootstrapurl" }, { "url", "bootstrapurl" },
QCoreApplication::translate("application", "bootstrap URL, e.g. datastore.swift-project.org"), QCoreApplication::translate("application", "bootstrap URL, e.g. https://datastore.swift-project.org/shared"),
"bootstrapurl", (sApp->isUnitTest()) ? unitTestBootstrapUrl() : "" "bootstrapurl", (sApp->isUnitTest()) ? unitTestBootstrapUrl() : ""
}, m_cmdBootstrapMode }, m_cmdBootstrapMode
{ {
@@ -75,8 +75,8 @@ namespace BlackCore
CGlobalSetup cachedSetup = m_setup.get(); CGlobalSetup cachedSetup = m_setup.get();
const bool cacheAvailable = cachedSetup.wasLoaded(); const bool cacheAvailable = cachedSetup.wasLoaded();
msgs.push_back(cacheAvailable ? msgs.push_back(cacheAvailable ?
CStatusMessage(this, CStatusMessage::SeverityInfo , "Cached setup syncronized and contains data") : CStatusMessage(this, CStatusMessage::SeverityInfo , "Cached setup synchronized and contains data") :
CStatusMessage(this, CStatusMessage::SeverityInfo , "Cached setup syncronized, but no data") CStatusMessage(this, CStatusMessage::SeverityInfo , "Cached setup synchronized, but no data")
); );
if (this->m_bootstrapMode == CacheOnly) if (this->m_bootstrapMode == CacheOnly)
{ {

5
src/blackcore/setupreader.h
View File

@@ -30,7 +30,6 @@
class QNetworkReply; class QNetworkReply;
namespace BlackMisc { class CLogCategoryList; } namespace BlackMisc { class CLogCategoryList; }
namespace BlackCore namespace BlackCore
{ {
//! Read the central URLs / locations of our data / setup. //! Read the central URLs / locations of our data / setup.
@@ -39,7 +38,9 @@ namespace BlackCore
//! update information. //! update information.
//! //!
//! \note This class is no(!) BlackCore::CThreadedReader as it will be loaded once during startup //! \note This class is no(!) BlackCore::CThreadedReader as it will be loaded once during startup
//! and reading setup data is fast. //! and reading setup data is fast. The read file is also called "bootstrap" file as it tells
//! swift which data are located where. Without that file we cannot start. Once the file is in place (ie in the cache)
//! it can be automatically updated.
//! //!
//! \sa BlackCore::Data::TGlobalSetup //! \sa BlackCore::Data::TGlobalSetup
//! \sa BlackCore::Data::TUpdateInfo //! \sa BlackCore::Data::TUpdateInfo