Formatting from refs #678

samples/blackmiscdbus/servicetool.h

@@ -33,11 +33,10 @@ namespace BlackMisc { class CDBusServer; }
 
 namespace BlackSample
 {
-	
     class Testservice; // forward declaration
 
     /*!
-     * \brief Supporting / helper functions for running the tests
+     * Supporting / helper functions for running the tests
      */
     class ServiceTool
     {
@@ -45,92 +44,45 @@ namespace BlackSample
         ServiceTool() {}
 
     public:
-        /*!
+        //! Process id
-         * \brief Get process id
-         * \return
-         */
         static qint64 getPid()
         {
             return QCoreApplication::applicationPid();
         }
 
-        /*!
+        //! Client side of data transfer test
-         * \brief Client side of data transfer test
-         * \param address
-         */
         static void dataTransferTestClient(const QString &address);
 
-        /*!
+        //! Server side of data transfer test
-         * \brief Server side of data transfer test
-         */
         static void dataTransferTestServer(BlackMisc::CDBusServer *dBusServer);
 
-        /*!
+        //! Start a new process
-         * \brief Start a new process
-         * \param executable
-         * \param arguments
-         * \param parent
-         * \return
-         */
         static QProcess *startNewProcess(const QString &executable, const QStringList &arguments = QStringList(), QObject *parent = 0);
 
-        /*!
+        //! Loop to send data to test service (slots on server)
-         * \brief Loop to send data to test service (slots on server)
-         * \param connection
-         */
         static void sendDataToTestservice(const QDBusConnection &connection);
 
-        /*!
+        //! Display QDBusArgument
-         * \brief Display QDBusArgument
-         * \param arg
-         * \param level
-         */
         static void displayQDBusArgument(const QDBusArgument &arg, qint32 level = 0);
 
-        /*!
+        //! Register testservice with connection
-         * \brief Register testservice with connection
-         * \param connection
-         * \param parent
-         * \return test service object
-         */
         static Testservice *registerTestservice(QDBusConnection &connection, QObject *parent = 0);
 
-        /*!
+        //! Get a random callsign
-         * \brief Get a random callsign
-         * \return
-         */
         static BlackMisc::Aviation::CCallsign getRandomAtcCallsign();
 
-        /*!
+        //! Get stations
-         * \brief Get stations
-         * \param number
-         * \return
-         */
         static BlackMisc::Aviation::CAtcStationList getStations(int number);
 
-        /*!
+        //! Get aircraft cfg entries
-         * \brief Get aircraft cfg entries
-         * \param number
-         * \return
-         */
         static BlackMisc::Simulation::FsCommon::CAircraftCfgEntriesList getAircraftCfgEntries(int number);
 
-        /*!
+        //! Get airports
-         * \brief Get airports
-         * \param number
-         * \return
-         */
         static BlackMisc::Aviation::CAirportList getAirports(int number);
 
-        /*!
+        //! Get clients
-         * \brief Get clients
-         * \param number
-         * \return
-         */
         static BlackMisc::Network::CClientList getClients(int number);
-
     };
-
 } // namespace
 
 #endif // guard

src/blackcore/airspacemonitor.h

@@ -75,65 +75,25 @@ namespace BlackCore
         //! Constructor
         CAirspaceMonitor(BlackMisc::Simulation::IOwnAircraftProvider *ownAircraft, INetwork *network, QObject *parent);
 
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::getAircraftInRange
+        //! \name IRemoteAircraftProvider overrides
         //! \ingroup remoteaircraftprovider
+        //! @{
         virtual BlackMisc::Simulation::CSimulatedAircraftList getAircraftInRange() const override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::getAircraftInRangeForCallsign
-        //! \ingroup remoteaircraftprovider
         virtual BlackMisc::Simulation::CSimulatedAircraft getAircraftInRangeForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::getAircraftInRangeForCallsign
-        //! \ingroup remoteaircraftprovider
         virtual BlackMisc::Simulation::CAircraftModel getAircraftInRangeModelForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::getAircraftInRangeCount
-        //! \ingroup remoteaircraftprovider
         virtual int getAircraftInRangeCount() const override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::getLatestAirspaceAircraftSnapshot
-        //! \ingroup remoteaircraftprovider
         virtual BlackMisc::Simulation::CAirspaceAircraftSnapshot getLatestAirspaceAircraftSnapshot() const override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::remoteAircraftSituations
-        //! \ingroup remoteaircraftprovider
         virtual BlackMisc::Aviation::CAircraftSituationList remoteAircraftSituations(const BlackMisc::Aviation::CCallsign &callsign) const override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::remoteAircraftSituationsCount
-        //! \ingroup remoteaircraftprovider
         virtual int remoteAircraftSituationsCount(const BlackMisc::Aviation::CCallsign &callsign) const override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::remoteAircraftParts
-        //! \ingroup remoteaircraftprovider
         virtual BlackMisc::Aviation::CAircraftPartsList remoteAircraftParts(const BlackMisc::Aviation::CCallsign &callsign, qint64 cutoffTimeValuesBefore = -1) const override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::isRemoteAircraftSupportingParts
-        //! \ingroup remoteaircraftprovider
         virtual bool isRemoteAircraftSupportingParts(const BlackMisc::Aviation::CCallsign &callsign) const override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::remoteAircraftSupportingParts
-        //! \ingroup remoteaircraftprovider
         virtual BlackMisc::Aviation::CCallsignSet remoteAircraftSupportingParts() const override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::updateAircraftEnabled
-        //! \ingroup remoteaircraftprovider
         virtual bool updateAircraftEnabled(const BlackMisc::Aviation::CCallsign &callsign, bool enabledForRedering, const BlackMisc::CIdentifier &originator) override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::updateAircraftModel
-        //! \ingroup remoteaircraftprovider
         virtual bool updateAircraftModel(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Simulation::CAircraftModel &model, const BlackMisc::CIdentifier &originator) override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::updateFastPositionEnabled
-        //! \ingroup remoteaircraftprovider
         virtual bool updateFastPositionEnabled(const BlackMisc::Aviation::CCallsign &callsign, bool enableFastPositonUpdates, const BlackMisc::CIdentifier &originator) override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::updateAircraftRendered
-        //! \ingroup remoteaircraftprovider
         virtual bool updateAircraftRendered(const BlackMisc::Aviation::CCallsign &callsign, bool rendered, const BlackMisc::CIdentifier &originator) override;
-
-        //! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::updateMarkAllAsNotRendered
-        //! \ingroup remoteaircraftprovider
         virtual void updateMarkAllAsNotRendered(const BlackMisc::CIdentifier &originator) override;
+        //! @}
 
         //! Returns the list of users we know about
         BlackMisc::Network::CUserList getUsers() const;
@@ -231,14 +191,14 @@ namespace BlackCore
         void airspaceAircraftSnapshot(const BlackMisc::Simulation::CAirspaceAircraftSnapshot &snapshot);
 
     private:
-        BlackMisc::Aviation::CAtcStationList           m_atcStationsOnline;
+        BlackMisc::Aviation::CAtcStationList           m_atcStationsOnline;  //!< online ATC stations
-        BlackMisc::Aviation::CAtcStationList           m_atcStationsBooked;
+        BlackMisc::Aviation::CAtcStationList           m_atcStationsBooked;  //!< booked ATC stations
-        BlackMisc::Network::CClientList                m_otherClients;
+        BlackMisc::Network::CClientList                m_otherClients;       //!< client informatiom
-        BlackMisc::Simulation::CSimulatedAircraftList  m_aircraftInRange; //!< aircraft, thread safe access required
+        BlackMisc::Simulation::CSimulatedAircraftList  m_aircraftInRange;    //!< aircraft, thread safe access required
 
         // hashs, because not sorted by key but keeping order
-        CSituationsPerCallsign m_situationsByCallsign; //!< situations, for performance reasons per callsign, thread safe access required
+        CSituationsPerCallsign            m_situationsByCallsign;    //!< situations, for performance reasons per callsign, thread safe access required
-        CPartsPerCallsign      m_partsByCallsign;      //!< parts, for performance reasons per callsign, thread safe access required
+        CPartsPerCallsign                 m_partsByCallsign;         //!< parts, for performance reasons per callsign, thread safe access required
         BlackMisc::Aviation::CCallsignSet m_aircraftSupportingParts; //!< aircraft supporting parts, thread safe access required
 
         QMap<BlackMisc::Aviation::CCallsign, BlackMisc::Aviation::CFlightPlan>       m_flightPlanCache; //!< flight plan information retrieved any cached

src/blackcore/webdataservices.cpp

@@ -397,7 +397,7 @@ namespace BlackCore
         return 0;
     }
 
-    CAirlineIcaoCodeList CWebDataServices::getAirlineIcaoCodeForDesignator(const QString &designator) const
+    CAirlineIcaoCodeList CWebDataServices::getAirlineIcaoCodesForDesignator(const QString &designator) const
     {
         if (m_icaoDataReader) { return m_icaoDataReader->getAirlineIcaoCodesForDesignator(designator); }
         return CAirlineIcaoCodeList();

src/blackcore/webdataservices.h

@@ -230,9 +230,9 @@ namespace BlackCore
         //! \threadsafe
         int getAirlineIcaoCodesCount() const;
 
-        //! ICAO code for designator
+        //! ICAO codes for designator
         //! \threadsafe
-        BlackMisc::Aviation::CAirlineIcaoCodeList getAirlineIcaoCodeForDesignator(const QString &designator) const;
+        BlackMisc::Aviation::CAirlineIcaoCodeList getAirlineIcaoCodesForDesignator(const QString &designator) const;
 
         //! ICAO code for id
         //! \threadsafe

src/blackmisc/simulation/aircraftmodel.cpp

@@ -105,9 +105,9 @@ namespace BlackMisc
 
         bool CAircraftModel::canInitializeFromFsd() const
         {
-            bool nw = this->getModelType() == CAircraftModel::TypeQueriedFromNetwork ||
+            const bool nw = this->getModelType() == CAircraftModel::TypeQueriedFromNetwork ||
-                      this->getModelType() == CAircraftModel::TypeFsdData ||
+                            this->getModelType() == CAircraftModel::TypeFsdData ||
-                      this->getModelType() == CAircraftModel::TypeUnknown;
+                            this->getModelType() == CAircraftModel::TypeUnknown;
             return nw;
         }