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!
This commit is contained in:
Klaus Basan
2014-01-17 22:53:37 +01:00
parent 6d10543d89
commit f883babc20
5 changed files with 22 additions and 39 deletions

View File

@@ -42,8 +42,6 @@ class MainWindow : public QMainWindow
public: public:
/*! /*!
* \brief Constructor * \brief Constructor
* \param windowMode
* \param parent
*/ */
explicit MainWindow(GuiModes::WindowMode windowMode, QWidget *parent = nullptr); explicit MainWindow(GuiModes::WindowMode windowMode, QWidget *parent = nullptr);
@@ -54,7 +52,6 @@ public:
/*! /*!
* \brief Init data * \brief Init data
* \param coreMode
*/ */
void init(GuiModes::CoreMode coreMode); void init(GuiModes::CoreMode coreMode);
@@ -66,19 +63,16 @@ public:
protected: protected:
/*! /*!
* \brief Close event, e.g. when window is closed * \brief Close event, e.g. when window is closed
* \param event
*/ */
void closeEvent(QCloseEvent *event); void closeEvent(QCloseEvent *event);
/*! /*!
* \brief Mouse moving, required for frameless window * \brief Mouse moving, required for frameless window
* \param event
*/ */
void mouseMoveEvent(QMouseEvent *event); void mouseMoveEvent(QMouseEvent *event);
/*! /*!
* \brief Mouse press, required for frameless window * \brief Mouse press, required for frameless window
* \param event
*/ */
void mousePressEvent(QMouseEvent *event); void mousePressEvent(QMouseEvent *event);
@@ -138,8 +132,8 @@ private:
void updateGuiStatusInformation(); void updateGuiStatusInformation();
/*! /*!
* \brief Update the selected server textboxs * \brief Update the selected server textboxes
* \param server * \param server to be displayed
*/ */
void updateGuiSelectedServerTextboxes(const BlackMisc::Network::CServer &server); void updateGuiSelectedServerTextboxes(const BlackMisc::Network::CServer &server);
@@ -417,7 +411,7 @@ private slots:
/*! /*!
* \brief Audio device selected * \brief Audio device selected
* \param index * \param index audio device index (COM1, COM2)
*/ */
void audioDeviceSelected(int index); void audioDeviceSelected(int index);

View File

@@ -137,12 +137,20 @@ namespace BlackMisc
} }
public: // CValueObject overrides public: // CValueObject overrides
/*!
* \copydoc CValueObject::toQVariant()
*/
virtual QVariant toQVariant() const { return QVariant::fromValue(derived()); } 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()); } virtual uint getValueHash() const { return qHash(&derived()); }
protected: // CValueObject overrides protected: // CValueObject overrides
/*!
* \copydoc CValueObject::convertToQString()
*/
virtual QString convertToQString(bool i18n = false) const virtual QString convertToQString(bool i18n = false) const
{ {
QString str; QString str;

View File

@@ -256,7 +256,6 @@ namespace BlackMisc
/*! /*!
* \brief Stream from DBus * \brief Stream from DBus
* \param argument
*/ */
virtual void unmarshallFromDbus(const QDBusArgument &) virtual void unmarshallFromDbus(const QDBusArgument &)
{ {

View File

@@ -158,46 +158,38 @@ namespace BlackMisc
/*! /*!
* \brief Cast as QString * \brief Cast as QString
* \bool i18n
*/ */
QString toQString(bool i18n = false) const; QString toQString(bool i18n = false) const;
/*! /*!
* \brief Cast to pretty-printed QString * \brief Cast to pretty-printed QString
* \return
*/ */
virtual QString toFormattedQString(bool i18n = false) const; virtual QString toFormattedQString(bool i18n = false) const;
/*! /*!
* \brief To std string * \brief To std string
* \param i18n
* \return
*/ */
std::string toStdString(bool i18n = false) const; std::string toStdString(bool i18n = false) const;
/*! /*!
* \brief Update by variant map * \brief Update by variant map
* \param valueMap
* \return
*/ */
int apply(const BlackMisc::CValueMap &valueMap); int apply(const BlackMisc::CValueMap &valueMap);
/*! /*!
* \brief Value hash, allows comparisons between QVariants * \brief Value hash, allows comparisons between QVariants
* \return
*/ */
virtual uint getValueHash() const = 0; virtual uint getValueHash() const = 0;
/*! /*!
* \brief Virtual method to return QVariant, used with DBUS QVariant lists * \brief Virtual method to return QVariant, used with DBus QVariant lists
* \return
*/ */
virtual QVariant toQVariant() const = 0; virtual QVariant toQVariant() const = 0;
/*! /*!
* \brief Set property by index * \brief Set property by index
* \remarks Intentionally not abstract, avoiding all classes need to implement this method * \remarks Intentionally not abstract, avoiding all classes need to implement this method
* \param index * \param index as used in Qt table views
* \return * \return
*/ */
virtual void setPropertyByIndex(const QVariant &variant, int index); virtual void setPropertyByIndex(const QVariant &variant, int index);
@@ -205,7 +197,7 @@ namespace BlackMisc
/*! /*!
* \brief Property by index * \brief Property by index
* \remarks Intentionally not abstract, avoiding all classes need to implement this method * \remarks Intentionally not abstract, avoiding all classes need to implement this method
* \param index * \param index as used in Qt table views
* \return * \return
*/ */
virtual QVariant propertyByIndex(int index) const; virtual QVariant propertyByIndex(int index) const;
@@ -213,8 +205,7 @@ namespace BlackMisc
/*! /*!
* \brief Property by index as String * \brief Property by index as String
* \remarks Intentionally not abstract, avoiding all classes need to implement this method * \remarks Intentionally not abstract, avoiding all classes need to implement this method
* \param index as used in Qt table views
* \param index
* \param i18n * \param i18n
* \return * \return
*/ */
@@ -222,8 +213,6 @@ namespace BlackMisc
/*! /*!
* \brief The stored object as CValueObject * \brief The stored object as CValueObject
* \param qv
* \return
*/ */
static const CValueObject *fromQVariant(const QVariant &qv); static const CValueObject *fromQVariant(const QVariant &qv);
@@ -240,13 +229,11 @@ namespace BlackMisc
/*! /*!
* \brief Copy assignment operator = * \brief Copy assignment operator =
* \return
*/ */
CValueObject &operator=(const CValueObject &) { return *this; } CValueObject &operator=(const CValueObject &) { return *this; }
/*! /*!
* \brief String for streaming operators * \brief String for streaming operators
* \return
*/ */
virtual QString stringForStreaming() const; virtual QString stringForStreaming() const;
@@ -283,13 +270,11 @@ namespace BlackMisc
/*! /*!
* \brief Marshall to DBus * \brief Marshall to DBus
* \param argument
*/ */
virtual void marshallToDbus(QDBusArgument &) const = 0; virtual void marshallToDbus(QDBusArgument &) const = 0;
/*! /*!
* \brief Unmarshall from DBus * \brief Unmarshall from DBus
* \param argument
*/ */
virtual void unmarshallFromDbus(const QDBusArgument &) = 0; virtual void unmarshallFromDbus(const QDBusArgument &) = 0;

View File

@@ -62,25 +62,22 @@ namespace BlackMisc
/*! /*!
* Get the voice room * Get the voice room
* \return
*/ */
const QString &getChannel() const { return m_channel; } const QString &getChannel() const { return m_channel; }
/*! /*!
* Set the host name * \brief Set the host name
* \param
*/ */
void setHostName(const QString &hostName) { m_hostname = hostName; } void setHostName(const QString &hostName) { m_hostname = hostName; }
/*! /*!
* Set the voice channel * \brief Set the voice channel
* \param
*/ */
void setChannel(const QString &channel) { m_channel = channel; } void setChannel(const QString &channel) { m_channel = channel; }
/*! /*!
* \brief Server URL * \brief Server URL
* \param noProtocol * \param noProtocol either with (pseudo) protocol prefix or without
* \return * \return
*/ */
QString getVoiceRoomUrl(bool noProtocol = true) const; QString getVoiceRoomUrl(bool noProtocol = true) const;
@@ -146,14 +143,14 @@ namespace BlackMisc
static void registerMetadata(); static void registerMetadata();
/*! /*!
* \brief Protocol * \brief Protocol prefix
* \return * \return
*/ */
static const QString &protocol() { static QString p("vvl"); return p; } static const QString &protocol() { static QString p("vvl"); return p; }
/*! /*!
* \brief Protocol * \brief Protocol
* \return * \return with protocol prefix or without
*/ */
static const QString &protocolComplete() { static QString p("vvl://"); return p; } static const QString &protocolComplete() { static QString p("vvl://"); return p; }