From 526cd916a8500f05184f74d40dd914f68f2e2414 Mon Sep 17 00:00:00 2001 From: Klaus Basan Date: Thu, 6 Feb 2014 03:22:42 +0100 Subject: [PATCH] refs #91 & #124 doxygen fixes, style/comment changes, typos, and override keywords --- src/blackcore/context_voice.h | 1 - src/blackcore/voice_vatlib.h | 150 +++++++------------ src/blackgui/columns.h | 26 +--- src/blackmisc/avaircraft.h | 19 +-- src/blackmisc/avatcstation.h | 270 +++++++++------------------------- src/blackmisc/avcallsign.h | 2 +- src/blackmisc/containerbase.h | 56 +++---- src/blackmisc/statusmessage.h | 2 +- src/blackmisc/valueobject.h | 49 +----- 9 files changed, 162 insertions(+), 413 deletions(-) diff --git a/src/blackcore/context_voice.h b/src/blackcore/context_voice.h index d8a16048b..ba8980f13 100644 --- a/src/blackcore/context_voice.h +++ b/src/blackcore/context_voice.h @@ -166,7 +166,6 @@ namespace BlackCore */ virtual void runSquelchTest() const; - private: CVoiceVatlib *m_voice; //!< underlying voice lib }; diff --git a/src/blackcore/voice_vatlib.h b/src/blackcore/voice_vatlib.h index 37c0492f5..e3c6cefc6 100644 --- a/src/blackcore/voice_vatlib.h +++ b/src/blackcore/voice_vatlib.h @@ -40,9 +40,7 @@ namespace BlackCore */ CVoiceVatlib(QObject *parent = nullptr); - /*! - * \brief Destructor - */ + //! \brief Destructor virtual ~CVoiceVatlib(); // Hardware devices @@ -50,133 +48,85 @@ namespace BlackCore // to different voice rooms and send their audio to different devices, e.g. ATIS to loudspeakers // and ATC to headspeakers. Is not important to implement that now, if ever. - /*! - * \copydoc IVoice::audioDevices() - */ - virtual const BlackMisc::Voice::CAudioDeviceList &audioDevices() const ; + //! \copydoc IVoice::audioDevices() + virtual const BlackMisc::Voice::CAudioDeviceList &audioDevices() const override; - /*! - * \copydoc IVoice::defaultAudioInputDevice() - */ - virtual const BlackMisc::Voice::CAudioDevice defaultAudioInputDevice() const; + //! \copydoc IVoice::defaultAudioInputDevice() + virtual const BlackMisc::Voice::CAudioDevice defaultAudioInputDevice() const override; - /*! - * \copydoc IVoice::defaultAudioOutputDevice() - */ - virtual const BlackMisc::Voice::CAudioDevice defaultAudioOutputDevice() const; + //! \copydoc IVoice::defaultAudioOutputDevice() + virtual const BlackMisc::Voice::CAudioDevice defaultAudioOutputDevice() const override; /************************************************ * SETUP TESTS - * *********************************************/ + ***********************************************/ - /*! - * \copydoc IVoice::runSquelchTest - */ - virtual void runSquelchTest(); + //! \copydoc IVoice::runSquelchTest + virtual void runSquelchTest() override; - /*! - * \copydoc IVoice::runMicTest - */ - virtual void runMicrophoneTest(); + //! \copydoc IVoice::runMicTest + virtual void runMicrophoneTest() override; - /*! - * \copydoc IVoice::inputSquelch - */ - virtual float inputSquelch() const; + //! \copydoc IVoice::inputSquelch + virtual float inputSquelch() const override; - /*! - * \copydoc IVoice::micTestResult() - */ - virtual qint32 micTestResult() const; + //! \copydoc IVoice::micTestResult() + virtual qint32 micTestResult() const override; - /*! - * \copydoc IVoice::micTestResultAsString - */ - virtual QString micTestResultAsString() const; + //! \copydoc IVoice::micTestResultAsString + virtual QString micTestResultAsString() const override; public slots: - /*! - * \copydoc IVoice::setMyAircraftCallsign() - */ - virtual void setMyAircraftCallsign(const BlackMisc::Aviation::CCallsign &callsign); + //! \copydoc IVoice::setMyAircraftCallsign() + virtual void setMyAircraftCallsign(const BlackMisc::Aviation::CCallsign &callsign) override; - /*! - * \copydoc IVoice::joinVoiceRoom() - */ - virtual void joinVoiceRoom(const ComUnit comUnit, const BlackMisc::Voice::CVoiceRoom &voiceRoom); + //! \copydoc IVoice::joinVoiceRoom() + virtual void joinVoiceRoom(const ComUnit comUnit, const BlackMisc::Voice::CVoiceRoom &voiceRoom) override; - /*! - * \copydoc IVoice::leaveVoiceRoom() - */ - virtual void leaveVoiceRoom(const ComUnit comUnit); + //! \copydoc IVoice::leaveVoiceRoom() + virtual void leaveVoiceRoom(const ComUnit comUnit) override; - /*! - * \copydoc IVoice::leaveAllVoiceRooms() - */ - virtual void leaveAllVoiceRooms(); + //! \copydoc IVoice::leaveAllVoiceRooms() + virtual void leaveAllVoiceRooms() override; - /*! - * \copydoc IVoice::setRoomOutputVolume() - */ - virtual void setRoomOutputVolume(const ComUnit comUnit, const qint32 volumne); + //! \copydoc IVoice::setRoomOutputVolume() + virtual void setRoomOutputVolume(const ComUnit comUnit, const qint32 volumne) override; - /*! - * \copydoc IVoice::startTransmitting() - */ - virtual void startTransmitting(const ComUnit comUnit); + //! \copydoc IVoice::startTransmitting() + virtual void startTransmitting(const ComUnit comUnit) override; - /*! - * \copydoc IVoice::stopTransmitting() - */ - virtual void stopTransmitting(const ComUnit comUnit); + //! \copydoc IVoice::stopTransmitting() + virtual void stopTransmitting(const ComUnit comUnit) override; - /*! - * \copydoc IVoice::getComVoiceRoomsWithAudioStatus() - */ - virtual BlackMisc::Voice::CVoiceRoomList getComVoiceRoomsWithAudioStatus() const; + //! \copydoc IVoice::getComVoiceRoomsWithAudioStatus() + virtual BlackMisc::Voice::CVoiceRoomList getComVoiceRoomsWithAudioStatus() const override; - /*! - * \copydoc IVoice::getComVoiceRooms() - */ - virtual BlackMisc::Voice::CVoiceRoomList getComVoiceRooms() const + //! \copydoc IVoice::getComVoiceRooms() + virtual BlackMisc::Voice::CVoiceRoomList getComVoiceRooms() const override { return this->m_voiceRooms; } - /*! - * \copydoc IVoice::getVoiceRoomCallsigns() - */ - virtual BlackMisc::Aviation::CCallsignList getVoiceRoomCallsigns(const ComUnit comUnit) const; + //! \copydoc IVoice::getVoiceRoomCallsigns() + virtual BlackMisc::Aviation::CCallsignList getVoiceRoomCallsigns(const ComUnit comUnit) const override; - /*! - * \copydoc IVoice::setInputDevice - */ - virtual void setInputDevice(const BlackMisc::Voice::CAudioDevice &device); + //! \copydoc IVoice::setInputDevice + virtual void setInputDevice(const BlackMisc::Voice::CAudioDevice &device) override; - /*! - * \copydoc IVoice::setOutputDevice - */ - virtual void setOutputDevice(const BlackMisc::Voice::CAudioDevice &device); + //! \copydoc IVoice::setOutputDevice + virtual void setOutputDevice(const BlackMisc::Voice::CAudioDevice &device) override; - /*! - * \brief Current input device - */ - virtual BlackMisc::Voice::CAudioDevice getCurrentInputDevice() const; + //! \copydoc IVoice::getCurrentInputDevice() + virtual BlackMisc::Voice::CAudioDevice getCurrentInputDevice() const override; - /*! - * \brief Current output device - */ - virtual BlackMisc::Voice::CAudioDevice getCurrentOutputDevice() const; + //! \copydoc IVoice::getCurrentOutputDevice() + virtual BlackMisc::Voice::CAudioDevice getCurrentOutputDevice() const override; - /*! - * \copydoc IVoice::switchAudioOutput - */ - virtual void switchAudioOutput(const ComUnit comUnit, bool enable); + //! \copydoc IVoice::switchAudioOutput + virtual void switchAudioOutput(const ComUnit comUnit, bool enable) override; - /*! - * \copydoc IVoice::isMuted - */ - virtual bool isMuted() const + //! \copydoc IVoice::isMuted + virtual bool isMuted() const override { if (this->m_outputEnabled.isEmpty()) return false; bool enabled = this->m_outputEnabled[COM1] || this->m_outputEnabled[COM2]; diff --git a/src/blackgui/columns.h b/src/blackgui/columns.h index 80e3f1810..4a6d72fc9 100644 --- a/src/blackgui/columns.h +++ b/src/blackgui/columns.h @@ -50,35 +50,19 @@ namespace BlackGui */ QString columnToName(int column) const; - /*! - * \brief Column to property index - * \param index - */ + //! \brief Column to property index int columnToPropertyIndex(int column) const; - /*! - * \brief Property index to column - * \param propertyIndex - * \return - */ + //! \brief Property index to column int propertyIndexToColumn(int propertyIndex) const; - /*! - * \brief Column index to property index - * \param index - */ + //! \brief Column index to property index int indexToPropertyIndex(int index) const; - /*! - * \brief Column index to name - * \param index - */ + //! \brief Column index to name int nameToPropertyIndex(const QString &name) const; - /*! - * \brief Size (number of columns) - * \return - */ + //! \brief Size (number of columns) int size() const; /*! diff --git a/src/blackmisc/avaircraft.h b/src/blackmisc/avaircraft.h index 090cbab4d..a1001989c 100644 --- a/src/blackmisc/avaircraft.h +++ b/src/blackmisc/avaircraft.h @@ -287,20 +287,14 @@ namespace BlackMisc IndexIcao }; - /*! - * \copydoc CValueObject::propertyByIndex() - */ - virtual QVariant propertyByIndex(int index) const; + //! \copydoc CValueObject::propertyByIndex() + virtual QVariant propertyByIndex(int index) const override; - /*! - * \copydoc CValueObject::propertyByIndexAsString() - */ - virtual QString propertyByIndexAsString(int index, bool i18n) const; + //! \copydoc CValueObject::propertyByIndexAsString() + virtual QString propertyByIndexAsString(int index, bool i18n) const override; - /*! - * \copydoc CValueObject::setPropertyByIndex() - */ - virtual void setPropertyByIndex(const QVariant &variant, int index); + //! \copydoc CValueObject::setPropertyByIndex(variant, index) + virtual void setPropertyByIndex(const QVariant &variant, int index) override; protected: /*! @@ -343,7 +337,6 @@ namespace BlackMisc CAircraftIcao m_icao; BlackMisc::PhysicalQuantities::CLength m_distanceToPlane; - }; } // namespace } // namespace diff --git a/src/blackmisc/avatcstation.h b/src/blackmisc/avatcstation.h index 00229d69b..50894098f 100644 --- a/src/blackmisc/avatcstation.h +++ b/src/blackmisc/avatcstation.h @@ -81,128 +81,79 @@ namespace BlackMisc bool isOnline = false, const QDateTime &bookedFromUtc = QDateTime(), const QDateTime &bookedUntilUtc = QDateTime(), const CInformationMessage &atis = CInformationMessage(CInformationMessage::ATIS), const CInformationMessage &metar = CInformationMessage(CInformationMessage::METAR)); - /*! - * \copydoc CValueObject::toQVariant() - */ + //! \copydoc CValueObject::toQVariant() virtual QVariant toQVariant() const { return QVariant::fromValue(*this); } - /*! - * \brief Equal operator == - */ + //! \brief Equal operator == bool operator ==(const CAtcStation &other) const; - /*! - * \brief Unequal operator == - */ + //! \brief Unequal operator != bool operator !=(const CAtcStation &other) const; - /*! - * \brief Has booking times? - */ + //! \brief Has booking times? bool hasBookingTimes() const { return !(this->m_bookedFromUtc.isNull() && this->m_bookedUntilUtc.isNull()); } - /*! - * \brief Has ATIS? - */ + //! \brief Has ATIS? bool hasAtis() const { return this->m_atis.hasMessage(); } - /*! - * \brief Has Metar? - */ + //! \brief Has METAR? bool hasMetar() const { return this->m_metar.hasMessage(); } - /*! - * Get callsign. - * \return - */ + //! Get callsign. const CCallsign &getCallsign() const { return m_callsign; } - /*! - * Get callsign as string. - */ + //! Get callsign as string. QString getCallsignAsString() const { return m_callsign.asString(); } - /*! - * Set callsign - */ + //! Set callsign void setCallsign(const CCallsign &callsign) { this->m_callsign = callsign; this->m_controller.setCallsign(callsign);} - /*! - * Get controller - * \return - */ + //! Get controller const BlackMisc::Network::CUser &getController() const { return m_controller; } - /*! - * Get controller name. - * \return - */ + //! Get controller name. QString getControllerRealName() const { return m_controller.getRealName(); } - /*! - * Get controller name. - * \return - */ + //! Get controller name. QString getControllerId() const { return m_controller.getId(); } - /*! - * Set controller - * \param controller - */ + //! Set controller void setController(const BlackMisc::Network::CUser &controller) { this->m_controller = controller; this->m_controller.setCallsign(this->m_callsign); } - /*! - * Set controller's name - * \param controllerName - */ + //! Set controller's name void setControllerRealName(const QString &controllerName) { this->m_controller.setRealName(controllerName); } - /*! - * Set controller's id - */ + //! Set controller's id void setControllerId(const QString &controllerId) { this->m_controller.setId(controllerId); } - /*! - * \brief Has valid realname? - */ + //! \brief Has valid realname? bool hasValidRealName() const { return this->m_controller.hasValidRealName(); } - /*! - * \brief Has valid id? - */ + //! \brief Has valid id? bool hasValidId() const { return this->m_controller.hasValidId(); } - /*! - * Get frequency. - */ + //! Get frequency. const BlackMisc::PhysicalQuantities::CFrequency &getFrequency() const { return m_frequency; } - /*! - * Set frequency - */ + //! Set frequency void setFrequency(const BlackMisc::PhysicalQuantities::CFrequency &frequency) { this->m_frequency = frequency; } - /*! - * Get the position of the center of the controller's area of visibility. - */ + //! Get the position of the center of the controller's area of visibility. const BlackMisc::Geo::CCoordinateGeodetic &getPosition() const { return m_position; } - /*! - * Set position - * \param position - */ + //! Set position void setPosition(const BlackMisc::Geo::CCoordinateGeodetic &position) { this->m_position = position; } /*! @@ -212,80 +163,50 @@ namespace BlackMisc */ void syncronizeControllerData(CAtcStation &otherStation); - /*! - * Get the radius of the controller's area of visibility. - * \return - */ + //! \brief Get the radius of the controller's area of visibility. const BlackMisc::PhysicalQuantities::CLength &getRange() const { return m_range; } - /*! - * Set range - * \param range - */ + //! \brief Set range void setRange(const BlackMisc::PhysicalQuantities::CLength &range) { this->m_range = range; } - /*! - * Get the distance to own plane - */ + //! Get the distance to own plane const BlackMisc::PhysicalQuantities::CLength &getDistanceToPlane() const { return m_distanceToPlane; } - /*! - * Set distance to own plane - */ + //! Set distance to own plane void setDistanceToPlane(const BlackMisc::PhysicalQuantities::CLength &distance) { this->m_distanceToPlane = distance; } - /*! - * \brief Valid distance? - */ + //! \brief Valid distance? bool hasValidDistance() const { return !this->m_distanceToPlane.isNegativeWithEpsilonConsidered();} /*! * \brief Calculcate distance to plane, set it, and also return it - * \param position + * \param position other position * \return */ const BlackMisc::PhysicalQuantities::CLength &calculcateDistanceToPlane(const BlackMisc::Geo::CCoordinateGeodetic &position); - /*! - * \brief Is station online (or just booked) - * \return - */ + //! \brief Is station online (or just booked)? bool isOnline() const { return m_isOnline; } - /*! - * Set online - * \param online - */ + //! Set online void setOnline(bool online) { this->m_isOnline = online; } - /*! - * \brief Get voice room - * \return - */ + //! \brief Get voice room const BlackMisc::Voice::CVoiceRoom &getVoiceRoom() const { return this->m_voiceRoom; } - /*! - * \brief Set voice room - * \param - */ + //! \brief Set voice room void setVoiceRoom(const BlackMisc::Voice::CVoiceRoom &voiceRoom) { this->m_voiceRoom = voiceRoom; } - /*! - * \brief Valid voice room? - * \return - */ + //! \brief Valid voice room? bool hasValidVoiceRoom() const { return this->m_voiceRoom.isValid(); } /*! * Booked date/time if any. * This represents the closest booking within a time frame as there can be multiple bookings. - * \return */ const QDateTime &getBookedFromUtc() const { return m_bookedFromUtc; } - /*! - * Set booked from - */ + //! Set booked from void setBookedFromUtc(const QDateTime &from) { this->m_bookedFromUtc = from; } /*! @@ -294,34 +215,24 @@ namespace BlackMisc */ const QDateTime &getBookedUntilUtc() const { return m_bookedUntilUtc; } - /*! - * \brief Has valid booking times? - */ + //! \brief Has valid booking times? bool hasValidBookingTimes() const { return !this->m_bookedFromUtc.isNull() && this->m_bookedFromUtc.isValid() && !this->m_bookedUntilUtc.isNull() && this->m_bookedUntilUtc.isValid(); } - /*! - * \brief Transfer booking times - * \param otherStation - */ + //! \brief Transfer booking times void setBookedFromUntil(const CAtcStation &otherStation) { this->setBookedFromUtc(otherStation.getBookedFromUtc()); this->setBookedUntilUtc(otherStation.getBookedUntilUtc()); } - /*! - * \brief Booked now - * \return - */ + //! \brief Booked now? bool isBookedNow() const; - /*! - * \brief Tuned in within 25KHz channel spacing - */ + //! \brief Tuned in within 25KHz channel spacing bool isComUnitTunedIn25KHz(const BlackMisc::Aviation::CComSystem &comUnit) const { return comUnit.isActiveFrequencyWithin25kHzChannel(this->getFrequency()); @@ -336,117 +247,72 @@ namespace BlackMisc */ BlackMisc::PhysicalQuantities::CTime bookedWhen() const; - /*! - * \brief Get ATIS - * \return - */ + //! \brief Get ATIS const CInformationMessage &getAtis() const { return m_atis; } - /*! - * \brief Set ATIS - */ + //! \brief Set ATIS void setAtis(const CInformationMessage &atis) { this->m_atis = atis;} - /*! - * \brief Set ATIS Message - */ + //! \brief Set ATIS Message void setAtisMessage(const QString &atis) { this->m_atis.setMessage(atis); } - /*! - * \brief Get METAR - */ + //! \brief Get METAR const CInformationMessage &getMetar() const { return m_metar; } - /*! - * \brief Set METAR - */ + //! \brief Set METAR void setMetar(const CInformationMessage &metar) { this->m_metar = metar;} - /*! - * \brief Set METAR Message - */ + //! \brief Set METAR Message void setMetarMessage(const QString &metar) { this->m_metar.setMessage(metar); } - /*! - * Set booked until - */ + //! Set booked until void setBookedUntilUtc(const QDateTime &until) { this->m_bookedUntilUtc = until; } - /*! - * \brief Latitude - * \return - */ - virtual const BlackMisc::Geo::CLatitude &latitude() const + //! \brief Latitude + virtual const BlackMisc::Geo::CLatitude &latitude() const override { return this->getPosition().latitude(); } - /*! - * \brief Longitude - * \return - */ - virtual const BlackMisc::Geo::CLongitude &longitude() const + //! \brief Longitude + virtual const BlackMisc::Geo::CLongitude &longitude() const override { return this->getPosition().longitude(); } - /*! - * \copydoc CValueObject::getValueHash() - */ - virtual uint getValueHash() const; + //! \copydoc CValueObject::getValueHash() + virtual uint getValueHash() const override; - /*! - * \coypdoc CValueObject::propertyByIndex() - */ - virtual QVariant propertyByIndex(int index) const; + //! \copydoc CValueObject::propertyByIndex() + virtual QVariant propertyByIndex(int index) const override; - /*! - * \copydoc CValueObject::setPropertyByIndex(const QVariant &, int) - */ - virtual void setPropertyByIndex(const QVariant &variant, int index); + //! \copydoc CValueObject::setPropertyByIndex(variant, index) + virtual void setPropertyByIndex(const QVariant &variant, int index) override; - /*! - * \copydoc CValueObject::propertyByIndexAsString() - */ - virtual QString propertyByIndexAsString(int index, bool i18n = false) const; + //! \copydoc CValueObject::propertyByIndexAsString() + virtual QString propertyByIndexAsString(int index, bool i18n = false) const override; - /*! - * \brief Register metadata - */ + //! \brief Register metadata static void registerMetadata(); protected: - /*! - * \brief Meaningful string representation - * \param i18n - * \return - */ + //! \copydoc CValueObject::convertToQString virtual QString convertToQString(bool i18n = false) const; - /*! - * \copydoc CValueObject::getMetaTypeId - */ - virtual int getMetaTypeId() const; + //! \copydoc CValueObject::getMetaTypeId + virtual int getMetaTypeId() const override; - /*! - * \copydoc CValueObject::isA - */ - virtual bool isA(int metaTypeId) const; + //! \copydoc CValueObject::isA + virtual bool isA(int metaTypeId) const override; - /*! - * \copydoc CValueObject::compareImpl - */ - virtual int compareImpl(const CValueObject &other) const; + //! \copydoc CValueObject::compareImpl + virtual int compareImpl(const CValueObject &other) const override; - /*! - * \copydoc CValueObject::marshallToDbus() - */ - virtual void marshallToDbus(QDBusArgument &argument) const; + //! \copydoc CValueObject::marshallToDbus() + virtual void marshallToDbus(QDBusArgument &argument) const override; - /*! - * \copydoc CValueObject::unmarshallFromDbus() - */ - virtual void unmarshallFromDbus(const QDBusArgument &argument); + //! \copydoc CValueObject::unmarshallFromDbus() + virtual void unmarshallFromDbus(const QDBusArgument &argument) override; private: CCallsign m_callsign; diff --git a/src/blackmisc/avcallsign.h b/src/blackmisc/avcallsign.h index 782d25834..102d82ba9 100644 --- a/src/blackmisc/avcallsign.h +++ b/src/blackmisc/avcallsign.h @@ -150,7 +150,7 @@ namespace BlackMisc */ static QString unifyCallsign(const QString &callsign); - //! \representing icon + //! \brief representing icon static const QPixmap &convertToIcon(const CCallsign &callsign); private: diff --git a/src/blackmisc/containerbase.h b/src/blackmisc/containerbase.h index bbf2507a1..75271e67b 100644 --- a/src/blackmisc/containerbase.h +++ b/src/blackmisc/containerbase.h @@ -46,7 +46,7 @@ namespace BlackMisc C findBy(Predicate p) const { C result = derived(); - result.erase(std::remove_if(result.begin(), result.end(), [ = ](const T &value) { return !p(value); }), result.end()); + result.erase(std::remove_if(result.begin(), result.end(), [ = ](const T & value) { return !p(value); }), result.end()); return result; } @@ -94,7 +94,7 @@ namespace BlackMisc */ C findBy(const CValueMap &valueMap) const { - return findBy([ & ](const T &value) { return value == valueMap; }); + return findBy([ & ](const T & value) { return value == valueMap; }); } /*! @@ -132,7 +132,7 @@ namespace BlackMisc template void removeIf(Predicate p) { - for (auto it = derived().begin(); it != derived().end(); ) + for (auto it = derived().begin(); it != derived().end();) { if (p(*it)) { it = derived().erase(it); } else { ++it; } @@ -150,49 +150,39 @@ namespace BlackMisc removeIf(BlackMisc::Predicates::MemberEqual(key1, value1)); } - public: // CValueObject overrides - /*! - * \copydoc CValueObject::toQVariant() - */ - virtual QVariant toQVariant() const { return QVariant::fromValue(derived()); } + public: + //! \copydoc CValueObject::toQVariant() + virtual QVariant toQVariant() const override { return QVariant::fromValue(derived()); } - /*! - * \brief Comparing containers by hash will only compare their addresses - */ - virtual uint getValueHash() const { return qHash(&derived()); } + //! copydoc CValueObject::getValueHash + virtual uint getValueHash() const override { return qHash(&derived()); } protected: // CValueObject overrides - /*! - * \copydoc CValueObject::convertToQString() - */ - virtual QString convertToQString(bool i18n = false) const + //! \copydoc CValueObject::convertToQString() + virtual QString convertToQString(bool i18n = false) const override { QString str; // qualifying stringify with this-> to workaround bug in GCC 4.7.2 http://gcc.gnu.org/bugzilla/show_bug.cgi?id=56402 - std::for_each(derived().cbegin(), derived().cend(), [ & ](const T &value) { str += (str.isEmpty() ? "{" : ",") + this->stringify(value, i18n); }); + std::for_each(derived().cbegin(), derived().cend(), [ & ](const T & value) { str += (str.isEmpty() ? "{" : ",") + this->stringify(value, i18n); }); if (str.isEmpty()) { str = "{"; } return str += "}"; } - /*! - * \copydoc CValueObject::getMetaTypeId - */ - virtual int getMetaTypeId() const { return qMetaTypeId>(); } + //! \copydoc CValueObject::getMetaTypeId + virtual int getMetaTypeId() const override { return qMetaTypeId>(); } - /*! - * \copydoc CValueObject::isA - */ - virtual bool isA(int metaTypeId) const + //! \copydoc CValueObject::isA override + virtual bool isA(int metaTypeId) const override { if (metaTypeId == qMetaTypeId>()) { return true; } return CValueObject::isA(metaTypeId); } - /*! - * \copydoc CValueObject::compareImpl - */ - virtual int compareImpl(const CValueObject &/*other*/) const + //! \copydoc CValueObject::compareImpl() + virtual int compareImpl(const CValueObject &other) const override { + Q_UNUSED(other); + //const auto &o = static_cast(other); //if (derived().size() < o.derived().size()) { return -1; } //if (derived().size() > o.derived().size()) { return 1; } @@ -204,14 +194,16 @@ namespace BlackMisc return 0; } - virtual void marshallToDbus(QDBusArgument &argument) const + //! \copydoc CValueObject::marshallToDbus + virtual void marshallToDbus(QDBusArgument &argument) const override { argument.beginArray(qMetaTypeId()); - std::for_each(derived().cbegin(), derived().cend(), [ & ](const T &value) { argument << value; }); + std::for_each(derived().cbegin(), derived().cend(), [ & ](const T & value) { argument << value; }); argument.endArray(); } - virtual void unmarshallFromDbus(const QDBusArgument &argument) + //! \copydoc CValueObject::unmarshallFromDbus + virtual void unmarshallFromDbus(const QDBusArgument &argument) override { argument.beginArray(); while (!argument.atEnd()) { T value; argument >> value; derived().insert(value); } diff --git a/src/blackmisc/statusmessage.h b/src/blackmisc/statusmessage.h index 09bd942db..0b52d5889 100644 --- a/src/blackmisc/statusmessage.h +++ b/src/blackmisc/statusmessage.h @@ -124,7 +124,7 @@ namespace BlackMisc //! \brief Unspecific info message static CStatusMessage getInfoMessage(const QString &message); - //! \representing icon + //! \brief representing icon static const QPixmap &convertToIcon(const CStatusMessage &statusMessage); protected: diff --git a/src/blackmisc/valueobject.h b/src/blackmisc/valueobject.h index 3ba43af5f..ec355de26 100644 --- a/src/blackmisc/valueobject.h +++ b/src/blackmisc/valueobject.h @@ -46,12 +46,7 @@ namespace BlackMisc return textStream; } - /*! - * \brief Operator << when there is no debug stream - * \param nodebug - * \param uc - * \return - */ + //! \brief Operator << when there is no debug stream friend QNoDebug operator<<(QNoDebug nodebug, const CValueObject & /* uc */) { return nodebug; @@ -81,52 +76,22 @@ namespace BlackMisc return ostr; } - /*! - * \brief Unmarshalling operator >>, DBus to object - * \param argument - * \param uc - * \return - */ + //! \brief Unmarshalling operator >>, DBus to object friend const QDBusArgument &operator>>(const QDBusArgument &argument, CValueObject &uc); - /*! - * \brief Marshalling operator <<, object to DBus - * \param argument - * \param pq - * \return - */ + //! \brief Marshalling operator <<, object to DBus friend QDBusArgument &operator<<(QDBusArgument &argument, const CValueObject &uc); - /*! - * \brief Operator == with value map - * \param valueMap - * \param uc - * \return - */ + //! \brief Operator == with value map friend bool operator==(const CValueMap &valueMap, const CValueObject &uc); - /*! - * \brief Operator != with value map - * \param valueMap - * \param uc - * \return - */ + //! \brief Operator != with value map friend bool operator!=(const CValueMap &valueMap, const CValueObject &uc); - /*! - * \brief Operator == with value map - * \param uc - * \param valueMap - * \return - */ + //! \brief Operator == with value map friend bool operator==(const CValueObject &uc, const CValueMap &valueMap); - /*! - * \brief Operator != with value map - * \param uc - * \param valueMap - * \return - */ + //! \brief Operator != with value map friend bool operator!=(const CValueObject &uc, const CValueMap &valueMap); /*!