Fix doxygen documentation in src, samples and tests

refs #594

src/blackcore/audiodevicevatlib.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "audiodevicevatlib.h"
 #include "blackmisc/logmessage.h"
 
@@ -16,11 +18,13 @@ using namespace BlackMisc::Aviation;
 
 namespace BlackCore
 {
+    //! Cast void* to a pointer of CAudioInputDeviceVatlib
     CAudioInputDeviceVatlib *cbvar_cast_inputDevice(void *cbvar)
     {
         return static_cast<CAudioInputDeviceVatlib *>(cbvar);
     }
 
+    //! Cast void* to a pointer of CAudioOutputDeviceVatlib
     CAudioOutputDeviceVatlib *cbvar_cast_outputDevice(void *cbvar)
     {
         return static_cast<CAudioOutputDeviceVatlib *>(cbvar);
@@ -129,3 +133,5 @@ namespace BlackCore
         cbvar_cast_outputDevice(cbVar)->m_devices.push_back(outputDevice);
     }
 }
+
+//! \endcond

src/blackcore/blackcore.h

@@ -3,6 +3,11 @@
 
 //! \file
 
+/*!
+ * \defgroup blackcore BlackCore Library
+ * Backend services of the swift project, like dealing with the network or the simulators.
+ */
+
 /*!
  * \namespace BlackCore
  * Backend services of the swift project, like dealing with the network or the simulators.
@@ -23,8 +28,9 @@
  * Network settings traits.
  */
 
-/**
+/*!
  * \defgroup dbus DBus related functions, classes, or definitions.
+ * \ingroup blackcore
  */
 
 #endif // guard

src/blackcore/networkvatlib.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "networkvatlib.h"
 #include "blackmisc/project.h"
 #include "blackmisc/logmessage.h"
@@ -154,6 +156,7 @@ namespace BlackCore
         }
     }
 
+    //! Convert vatlib status code to INetwork::ConnectionStatus
     INetwork::ConnectionStatus convertConnectionStatus(VatConnectionStatus status)
     {
         switch (status)
@@ -640,6 +643,7 @@ namespace BlackCore
     /**********************************           shimlib callbacks           ************************************/
     /********************************** * * * * * * * * * * * * * * * * * * * ************************************/
 
+    //! Cast void* to a pointer of CNetworkVatlib
     CNetworkVatlib *cbvar_cast(void *cbvar)
     {
         return static_cast<CNetworkVatlib *>(cbvar);
@@ -1018,3 +1022,5 @@ namespace BlackCore
     }
 
 } // namespace
+
+//! \endcond

src/blackcore/voicechannelvatlib.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "voicechannelvatlib.h"
 #include "blackmisc/logmessage.h"
 
@@ -177,6 +179,7 @@ namespace BlackCore
         emit connectionStatusChanged(oldStatus, m_roomStatus);
     }
 
+    //! Cast void* to a pointer of CVoiceChannelVatlib
     CVoiceChannelVatlib *cbvar_cast_voiceChannel(void *cbvar)
     {
         return static_cast<CVoiceChannelVatlib *>(cbvar);
@@ -206,3 +209,5 @@ namespace BlackCore
         obj->updateRoomStatus(channel, oldStatus, newStatus);
     }
 } // ns
+
+//! \endcond

src/blackcore/webreaderflags.cpp

@@ -7,6 +7,8 @@
  * contained in the LICENSE file.
  */
 
+//! \cond PRIVATE
+
 #include "webreaderflags.h"
 
 using namespace BlackMisc::Network;
@@ -47,7 +49,7 @@ namespace BlackCore
         return f;
     }
 
-    bool CWebReaderFlags::isFromSwiftDb(CEntityFlags::Entity entity)
+    bool CWebReaderFlags::isFromSwiftDb(BlackMisc::Network::CEntityFlags::Entity entity)
     {
         return isFromSwiftDb(entityToReader(entity));
     }
@@ -58,3 +60,5 @@ namespace BlackCore
     }
 
 } // namespace
+
+//! \endcond