From f883babc203a248bb9ba4250064f567b948efe94 Mon Sep 17 00:00:00 2001 From: Klaus Basan Date: Fri, 17 Jan 2014 22:53:37 +0100 Subject: [PATCH] Only Doxygen fixes in order to answer https://dev.vatsim-germany.org/boards/22/topics/1417?r=1432#message-1432 Fixed some Doxygen warnings along with it No code changes! --- samples/blackgui/mainwindow.h | 12 +++--------- src/blackmisc/containerbase.h | 12 ++++++++++-- src/blackmisc/pqbase.h | 1 - src/blackmisc/valueobject.h | 23 ++++------------------- src/blackmisc/vvoiceroom.h | 13 +++++-------- 5 files changed, 22 insertions(+), 39 deletions(-) diff --git a/samples/blackgui/mainwindow.h b/samples/blackgui/mainwindow.h index 06f097cbb..3dc587521 100644 --- a/samples/blackgui/mainwindow.h +++ b/samples/blackgui/mainwindow.h @@ -42,8 +42,6 @@ class MainWindow : public QMainWindow public: /*! * \brief Constructor - * \param windowMode - * \param parent */ explicit MainWindow(GuiModes::WindowMode windowMode, QWidget *parent = nullptr); @@ -54,7 +52,6 @@ public: /*! * \brief Init data - * \param coreMode */ void init(GuiModes::CoreMode coreMode); @@ -66,19 +63,16 @@ public: protected: /*! * \brief Close event, e.g. when window is closed - * \param event */ void closeEvent(QCloseEvent *event); /*! * \brief Mouse moving, required for frameless window - * \param event */ void mouseMoveEvent(QMouseEvent *event); /*! * \brief Mouse press, required for frameless window - * \param event */ void mousePressEvent(QMouseEvent *event); @@ -138,8 +132,8 @@ private: void updateGuiStatusInformation(); /*! - * \brief Update the selected server textboxs - * \param server + * \brief Update the selected server textboxes + * \param server to be displayed */ void updateGuiSelectedServerTextboxes(const BlackMisc::Network::CServer &server); @@ -417,7 +411,7 @@ private slots: /*! * \brief Audio device selected - * \param index + * \param index audio device index (COM1, COM2) */ void audioDeviceSelected(int index); diff --git a/src/blackmisc/containerbase.h b/src/blackmisc/containerbase.h index df6052cd2..ce020a9c3 100644 --- a/src/blackmisc/containerbase.h +++ b/src/blackmisc/containerbase.h @@ -137,12 +137,20 @@ namespace BlackMisc } public: // CValueObject overrides + /*! + * \copydoc CValueObject::toQVariant() + */ virtual QVariant toQVariant() const { return QVariant::fromValue(derived()); } - // comparing containers by hash will only compare their addresses + /*! + * \brief Comparing containers by hash will only compare their addresses + */ virtual uint getValueHash() const { return qHash(&derived()); } protected: // CValueObject overrides + /*! + * \copydoc CValueObject::convertToQString() + */ virtual QString convertToQString(bool i18n = false) const { QString str; @@ -210,4 +218,4 @@ namespace BlackMisc } -#endif // guard \ No newline at end of file +#endif // guard diff --git a/src/blackmisc/pqbase.h b/src/blackmisc/pqbase.h index e5e5a9b99..02aabf833 100644 --- a/src/blackmisc/pqbase.h +++ b/src/blackmisc/pqbase.h @@ -256,7 +256,6 @@ namespace BlackMisc /*! * \brief Stream from DBus - * \param argument */ virtual void unmarshallFromDbus(const QDBusArgument &) { diff --git a/src/blackmisc/valueobject.h b/src/blackmisc/valueobject.h index e011272fc..ef8cbb030 100644 --- a/src/blackmisc/valueobject.h +++ b/src/blackmisc/valueobject.h @@ -158,46 +158,38 @@ namespace BlackMisc /*! * \brief Cast as QString - * \bool i18n */ QString toQString(bool i18n = false) const; /*! * \brief Cast to pretty-printed QString - * \return */ virtual QString toFormattedQString(bool i18n = false) const; /*! * \brief To std string - * \param i18n - * \return */ std::string toStdString(bool i18n = false) const; /*! * \brief Update by variant map - * \param valueMap - * \return */ int apply(const BlackMisc::CValueMap &valueMap); /*! * \brief Value hash, allows comparisons between QVariants - * \return */ virtual uint getValueHash() const = 0; /*! - * \brief Virtual method to return QVariant, used with DBUS QVariant lists - * \return + * \brief Virtual method to return QVariant, used with DBus QVariant lists */ virtual QVariant toQVariant() const = 0; /*! * \brief Set property by index * \remarks Intentionally not abstract, avoiding all classes need to implement this method - * \param index + * \param index as used in Qt table views * \return */ virtual void setPropertyByIndex(const QVariant &variant, int index); @@ -205,7 +197,7 @@ namespace BlackMisc /*! * \brief Property by index * \remarks Intentionally not abstract, avoiding all classes need to implement this method - * \param index + * \param index as used in Qt table views * \return */ virtual QVariant propertyByIndex(int index) const; @@ -213,8 +205,7 @@ namespace BlackMisc /*! * \brief Property by index as String * \remarks Intentionally not abstract, avoiding all classes need to implement this method - - * \param index + * \param index as used in Qt table views * \param i18n * \return */ @@ -222,8 +213,6 @@ namespace BlackMisc /*! * \brief The stored object as CValueObject - * \param qv - * \return */ static const CValueObject *fromQVariant(const QVariant &qv); @@ -240,13 +229,11 @@ namespace BlackMisc /*! * \brief Copy assignment operator = - * \return */ CValueObject &operator=(const CValueObject &) { return *this; } /*! * \brief String for streaming operators - * \return */ virtual QString stringForStreaming() const; @@ -283,13 +270,11 @@ namespace BlackMisc /*! * \brief Marshall to DBus - * \param argument */ virtual void marshallToDbus(QDBusArgument &) const = 0; /*! * \brief Unmarshall from DBus - * \param argument */ virtual void unmarshallFromDbus(const QDBusArgument &) = 0; diff --git a/src/blackmisc/vvoiceroom.h b/src/blackmisc/vvoiceroom.h index eeafea823..506b02f75 100644 --- a/src/blackmisc/vvoiceroom.h +++ b/src/blackmisc/vvoiceroom.h @@ -62,25 +62,22 @@ namespace BlackMisc /*! * Get the voice room - * \return */ const QString &getChannel() const { return m_channel; } /*! - * Set the host name - * \param + * \brief Set the host name */ void setHostName(const QString &hostName) { m_hostname = hostName; } /*! - * Set the voice channel - * \param + * \brief Set the voice channel */ void setChannel(const QString &channel) { m_channel = channel; } /*! * \brief Server URL - * \param noProtocol + * \param noProtocol either with (pseudo) protocol prefix or without * \return */ QString getVoiceRoomUrl(bool noProtocol = true) const; @@ -146,14 +143,14 @@ namespace BlackMisc static void registerMetadata(); /*! - * \brief Protocol + * \brief Protocol prefix * \return */ static const QString &protocol() { static QString p("vvl"); return p; } /*! * \brief Protocol - * \return + * \return with protocol prefix or without */ static const QString &protocolComplete() { static QString p("vvl://"); return p; }