From cca275b2784a05d909b89bdac9b69e9c5ba9b078 Mon Sep 17 00:00:00 2001
From: Klaus Basan <klaus.basan@klausbasan.de>
Date: Sun, 17 Dec 2017 19:59:09 +0100
Subject: [PATCH] Doxygen

---
 src/blackcore/blackcore.h                 | 14 ++++++++++----
 src/blackcore/db/airportdatareader.h      |  4 +---
 src/blackcore/db/backgrounddataupdater.h  |  4 +---
 src/blackcore/db/databaseauthentication.h |  4 ++--
 src/blackcore/db/networkwatchdog.h        |  4 +---
 src/blackgui/blackgui.h                   | 10 ++++++++++
 6 files changed, 25 insertions(+), 15 deletions(-)

diff --git a/src/blackcore/blackcore.h b/src/blackcore/blackcore.h
index 9bea32f08..243a0d1a8 100644
--- a/src/blackcore/blackcore.h
+++ b/src/blackcore/blackcore.h
@@ -14,13 +14,19 @@
  */
 
 /*!
- * \namespace BlackCore::Settings
- * Core settings traits.
+ * \namespace BlackCore::Data
+ * Core data traits (aka cached values) and classes.
  */
 
 /*!
- * \namespace BlackCore::Data
- * Core data traits (aka cached values) and classes.
+ * \namespace BlackCore::Db
+ * Classes interacting with the swift database (aka "datastore"). This includes the readers and related classes.
+ * Related model classes can be found in BlackMisc::Db
+ */
+
+/*!
+ * \namespace BlackCore::Settings
+ * Core settings traits.
  */
 
 /*!
diff --git a/src/blackcore/db/airportdatareader.h b/src/blackcore/db/airportdatareader.h
index f33409a00..033d6ca11 100644
--- a/src/blackcore/db/airportdatareader.h
+++ b/src/blackcore/db/airportdatareader.h
@@ -23,9 +23,7 @@ namespace BlackCore
 {
     namespace Db
     {
-        /**
-         * Reader for airport database.
-         */
+        //! Reader for airport database data.
         class BLACKCORE_EXPORT CAirportDataReader : public CDatabaseReader
         {
             Q_OBJECT
diff --git a/src/blackcore/db/backgrounddataupdater.h b/src/blackcore/db/backgrounddataupdater.h
index cd2b3bb99..32396b491 100644
--- a/src/blackcore/db/backgrounddataupdater.h
+++ b/src/blackcore/db/backgrounddataupdater.h
@@ -23,9 +23,7 @@ namespace BlackCore
 {
     namespace Db
     {
-        /**
-         * Update and consolidation of DB data
-         */
+        //! Update and consolidation of DB data
         class BLACKCORE_EXPORT CBackgroundDataUpdater : public BlackMisc::CContinuousWorker
         {
             Q_OBJECT
diff --git a/src/blackcore/db/databaseauthentication.h b/src/blackcore/db/databaseauthentication.h
index 9542dafd0..a994f13fb 100644
--- a/src/blackcore/db/databaseauthentication.h
+++ b/src/blackcore/db/databaseauthentication.h
@@ -21,13 +21,13 @@
 #include <QString>
 
 class QNetworkReply;
-namespace BlackMisc { namespace Network { class CAuthenticatedUser; } }
 
+namespace BlackMisc { namespace Network { class CAuthenticatedUser; } }
 namespace BlackCore
 {
     namespace Db
     {
-        //! Databse user used with swift DB. Features role and cookie handling.
+        //! Database user used with swift DB. Features role and cookie handling.
         class BLACKCORE_EXPORT CDatabaseAuthenticationService: public QObject
         {
             Q_OBJECT
diff --git a/src/blackcore/db/networkwatchdog.h b/src/blackcore/db/networkwatchdog.h
index 97754a60a..88b9835f7 100644
--- a/src/blackcore/db/networkwatchdog.h
+++ b/src/blackcore/db/networkwatchdog.h
@@ -22,9 +22,7 @@ namespace BlackCore
 {
     namespace Db
     {
-        /**
-         * Monitoring the swift DB, internet access, shared URL
-         */
+        //! Monitoring the swift DB, internet access, shared URLs
         class CNetworkWatchdog : public BlackMisc::CContinuousWorker
         {
             Q_OBJECT
diff --git a/src/blackgui/blackgui.h b/src/blackgui/blackgui.h
index b0a811466..46908a2ff 100644
--- a/src/blackgui/blackgui.h
+++ b/src/blackgui/blackgui.h
@@ -23,6 +23,11 @@
  * \brief High level reusable GUI components.
  */
 
+/*!
+ * \namespace BlackGui::Context
+ * \brief The context classes are high level API classes providing the interface for DBus.
+ */
+
 /*!
  * \namespace BlackGui::Filters
  * \brief Filter to search data sets.
@@ -33,6 +38,11 @@
  * \brief Models to be used with views, mainly QTableView
  */
 
+/*!
+ * \namespace BlackGui::Vatsim
+ * \brief Specific classes for the VATSIM network
+ */
+
 /*!
  * \namespace BlackGui::Views
  * \brief Views, mainly QTableView