Fix doxygen documentation in src, samples and tests

refs #594

src/blackmisc/datacache.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "datacache.h"
 #include "blackmisc/logmessage.h"
 #include "blackmisc/identifier.h"
@@ -16,6 +18,7 @@
 
 namespace BlackMisc
 {
+
     class CDataCacheRevision::LockGuard
     {
     public:
@@ -445,3 +448,5 @@ namespace BlackMisc
         return result;
     }
 }
+
+//! \endcond

src/blackmisc/icons.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "icons.h"
 #include "blackmisc/project.h"
 #include "blackmisc/fileutils.h"
@@ -1173,3 +1175,5 @@ namespace BlackMisc
     }
 
 } // namespace
+
+//! \endcond

src/blackmisc/lockfree.h

@@ -36,8 +36,10 @@ namespace BlackMisc
 
     namespace Private
     {
+        //! \cond PRIVATE
         //! \private
         BLACKMISC_EXPORT QMutex *atomicSharedPtrMutex();
+        //! \endcond
 
         //! \private
         template <typename T>

src/blackmisc/loghandler.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "loghandler.h"
 #include "algorithm.h"
 #include "worker.h"
@@ -23,6 +25,7 @@ namespace BlackMisc
         return g_handler;
     }
 
+    //! Qt message handler
     void messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &message)
     {
         CStatusMessage statusMessage(type, context, message);
@@ -264,3 +267,5 @@ namespace BlackMisc
         }
     }
 }
+
+//! \endcond

src/blackmisc/logmessage.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "logmessage.h"
 #include "blackmiscfreefunctions.h"
 #include "indexsequence.h"
@@ -155,11 +157,13 @@ namespace BlackMisc
         }
     }
 
+    //! Does category contain flag?
     bool hasFlag(const QString &category, const QString &flag)
     {
         return category.section("/", 1, -1).split("/").contains(flag);
     }
 
+    //! Add flag to category
     QString addFlag(QString category, const QString &flag)
     {
         if (category.isEmpty() || hasFlag(category, flag)) return category;
@@ -188,3 +192,5 @@ namespace BlackMisc
         }
     }
 } // ns
+
+//! \endcond

src/blackmisc/network/entityflags.cpp

@@ -39,7 +39,7 @@ namespace BlackMisc
             }
         }
 
-        QString CEntityFlags::flagToString(Entity flag)
+        QString CEntityFlags::flagToString(BlackMisc::Network::CEntityFlags::Entity flag)
         {
             QStringList list;
             if (flag.testFlag(NoEntity)) list << "no data";

src/blackmisc/project.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "project.h"
 #include "blackmisc/fileutils.h"
 #include "blackmisc/stringutils.h"
@@ -310,6 +312,7 @@ namespace BlackMisc
         return QProcessEnvironment::systemEnvironment().value(envVarPrivateSetupDir());
     }
 
+    //! Get application directory
     QString getApplicationDirImpl()
     {
         QFileInfo executable(QCoreApplication::applicationFilePath());
@@ -323,6 +326,7 @@ namespace BlackMisc
         return s;
     }
 
+    //! Get swift resource directory
     QString getSwiftResourceDirImpl()
     {
         QDir dir(CProject::getApplicationDir());
@@ -347,6 +351,7 @@ namespace BlackMisc
         return dir;
     }
 
+    //! Get static database directory
     QString getSwiftStaticDbFilesDirImpl()
     {
         QString d(CProject::getSwiftResourceDir());
@@ -362,6 +367,7 @@ namespace BlackMisc
         return s;
     }
 
+    //! Get images directory
     QString getImagesDirImpl()
     {
         QString d(CProject::getSwiftResourceDir());
@@ -452,3 +458,5 @@ namespace BlackMisc
 
 #undef BLACK_VERSION_STR
 #undef BLACK_VERSION_STR_X
+
+//! \endcond

src/blackmisc/propertyindexvariantmap.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "propertyindexvariantmap.h"
 #include "propertyindexlist.h"
 #include "dictionary.h"
@@ -125,3 +127,5 @@ namespace BlackMisc
         return BlackMisc::calculateHash(h, "CPropertyIndexVariantMap");
     }
 } // namespace
+
+//! \endcond

src/blackmisc/valuecache.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "blackmisc/valuecache.h"
 #include "blackmisc/identifier.h"
 #include "blackmisc/logmessage.h"
@@ -21,7 +23,7 @@ namespace BlackMisc
 
     using Private::CValuePage;
 
-    // Used in asserts to protect against signed integer overflow.
+    //! Used in asserts to protect against signed integer overflow.
     template <typename T>
     bool isSafeToIncrement(const T &value) { return value < std::numeric_limits<T>::max(); }
 
@@ -557,3 +559,5 @@ namespace BlackMisc
     }
 
 }
+
+//! \endcond

src/blackmisc/variant.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "variant.h"
 #include "blackmiscfreefunctions.h"
 #include "icon.h"
@@ -238,9 +240,14 @@ namespace BlackMisc
         }
     }
 
-    // 2 functions required for unmarshallFromDbus
+    /*!
+     * 2 functions required for unmarshallFromDbus
+     * \internal
+     */
+    //! @{
     QVariant fixQVariantFromDbusArgument(const QVariant &variant, int localUserType);
     QVariant complexQtTypeFromDbusArgument(const QDBusArgument &argument, int type);
+    //! @}
 
     void CVariant::unmarshallFromDbus(const QDBusArgument &arg)
     {
@@ -416,3 +423,5 @@ namespace BlackMisc
     }
 
 } // namespace
+
+//! \endcond

src/blackmisc/weather/metardecoder.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "metardecoder.h"
 #include "blackmiscfreefunctions.h"
 #include "blackmisc/logmessage.h"
@@ -804,7 +806,6 @@ namespace BlackMisc
             virtual QString getDecoderType() const override { return "WindShear"; }
         };
 
-
         CMetarDecoder::CMetarDecoder()
         {
             allocateDecoders();
@@ -854,3 +855,5 @@ namespace BlackMisc
 
     } // namespace
 } // namespace
+
+//! \endcond