aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2010-12-10 08:57:35 +0000
committerJeremy Lainé <jeremy.laine@m4x.org>2010-12-10 08:57:35 +0000
commite4b647e931e862ccdac12ef4a6b4e58ab5e76211 (patch)
tree2c87da1a6c5e2217fec2b47e53d0a6b7ed1b8eb4 /src
parent4b8f6e0d4e795bf58994d73c25fa48495dafaa8e (diff)
downloadqxmpp-e4b647e931e862ccdac12ef4a6b4e58ab5e76211.tar.gz
fix some documentation warnings
Diffstat (limited to 'src')
-rw-r--r--src/QXmppBindIq.h2
-rw-r--r--src/QXmppEntityTimeManager.cpp4
-rw-r--r--src/QXmppEntityTimeManager.h1
-rw-r--r--src/QXmppMucIq.h4
-rw-r--r--src/QXmppRosterManager.cpp7
-rw-r--r--src/QXmppRosterManager.h4
-rw-r--r--src/QXmppRpcIq.h6
-rw-r--r--src/QXmppSessionIq.h2
-rw-r--r--src/QXmppStun.cpp3
9 files changed, 24 insertions, 9 deletions
diff --git a/src/QXmppBindIq.h b/src/QXmppBindIq.h
index 7fb1b66c..04a20b32 100644
--- a/src/QXmppBindIq.h
+++ b/src/QXmppBindIq.h
@@ -42,7 +42,9 @@ public:
QString resource() const;
void setResource(const QString&);
+ /// \cond
static bool isBindIq(const QDomElement &element);
+ /// \endcond
protected:
/// \cond
diff --git a/src/QXmppEntityTimeManager.cpp b/src/QXmppEntityTimeManager.cpp
index 239bcfae..6a3faa2a 100644
--- a/src/QXmppEntityTimeManager.cpp
+++ b/src/QXmppEntityTimeManager.cpp
@@ -32,6 +32,10 @@
#include "QXmppEntityTimeIq.h"
#include "QXmppUtils.h"
+/// Request the time from an XMPP entity.
+///
+/// \param jid
+
QString QXmppEntityTimeManager::requestTime(const QString& jid)
{
QXmppEntityTimeIq request;
diff --git a/src/QXmppEntityTimeManager.h b/src/QXmppEntityTimeManager.h
index 434de4af..a007a41d 100644
--- a/src/QXmppEntityTimeManager.h
+++ b/src/QXmppEntityTimeManager.h
@@ -47,6 +47,7 @@ public:
/// \endcond
signals:
+ /// \brief This signal is emitted when a time response is received.
void timeReceived(const QXmppEntityTimeIq&);
};
diff --git a/src/QXmppMucIq.h b/src/QXmppMucIq.h
index 5bf27f47..01f5da63 100644
--- a/src/QXmppMucIq.h
+++ b/src/QXmppMucIq.h
@@ -69,7 +69,9 @@ public:
QList<QXmppMucAdminIq::Item> items() const;
void setItems(const QList<QXmppMucAdminIq::Item> &items);
+ /// \cond
static bool isMucAdminIq(const QDomElement &element);
+ /// \endcond
protected:
/// \cond
@@ -95,7 +97,9 @@ public:
QXmppDataForm form() const;
void setForm(const QXmppDataForm &form);
+ /// \cond
static bool isMucOwnerIq(const QDomElement &element);
+ /// \endcond
protected:
/// \cond
diff --git a/src/QXmppRosterManager.cpp b/src/QXmppRosterManager.cpp
index 6726a8c5..6252e04e 100644
--- a/src/QXmppRosterManager.cpp
+++ b/src/QXmppRosterManager.cpp
@@ -30,6 +30,8 @@
#include "QXmppRosterManager.h"
#include "QXmppUtils.h"
+/// Constructs a roster manager.
+
QXmppRosterManager::QXmppRosterManager(QXmppClient* client)
: m_isRosterReceived(false)
{
@@ -46,11 +48,6 @@ QXmppRosterManager::QXmppRosterManager(QXmppClient* client)
Q_ASSERT(check);
}
-QXmppRosterManager::~QXmppRosterManager()
-{
-
-}
-
/// Upon XMPP connection, request the roster.
///
void QXmppRosterManager::connected()
diff --git a/src/QXmppRosterManager.h b/src/QXmppRosterManager.h
index 4fd57022..eed43b79 100644
--- a/src/QXmppRosterManager.h
+++ b/src/QXmppRosterManager.h
@@ -65,11 +65,7 @@ class QXmppRosterManager : public QXmppClientExtension
Q_OBJECT
public:
- // FIXME : is this class really necessary?
- typedef QXmppRosterIq::Item QXmppRosterEntry;
-
QXmppRosterManager(QXmppClient* stream);
- ~QXmppRosterManager();
bool isRosterReceived();
QStringList getRosterBareJids() const;
diff --git a/src/QXmppRpcIq.h b/src/QXmppRpcIq.h
index 1d285649..e528f475 100644
--- a/src/QXmppRpcIq.h
+++ b/src/QXmppRpcIq.h
@@ -56,7 +56,9 @@ public:
QVariantList values() const;
void setValues(const QVariantList &values);
+ /// \cond
static bool isRpcResponseIq(const QDomElement &element);
+ /// \endcond
protected:
/// \cond
@@ -86,7 +88,9 @@ public:
QVariantList arguments() const;
void setArguments(const QVariantList &arguments);
+ /// \cond
static bool isRpcInvokeIq(const QDomElement &element);
+ /// \endcond
protected:
/// \cond
@@ -109,7 +113,9 @@ public:
QXmppRpcInvokeIq query() const;
void setQuery(const QXmppRpcInvokeIq &query);
+ /// \cond
static bool isRpcErrorIq(const QDomElement &element);
+ /// \endcond
protected:
/// \cond
diff --git a/src/QXmppSessionIq.h b/src/QXmppSessionIq.h
index 3b6a7622..c0e68b4e 100644
--- a/src/QXmppSessionIq.h
+++ b/src/QXmppSessionIq.h
@@ -36,7 +36,9 @@
class QXmppSessionIq : public QXmppIq
{
public:
+ /// \cond
static bool isSessionIq(const QDomElement &element);
+ /// \endcond
private:
/// \cond
diff --git a/src/QXmppStun.cpp b/src/QXmppStun.cpp
index 69f582d8..e7a468d8 100644
--- a/src/QXmppStun.cpp
+++ b/src/QXmppStun.cpp
@@ -316,6 +316,7 @@ void QXmppStunMessage::setPriority(quint32 priority)
///
/// \param buffer
/// \param password
+/// \param errors
bool QXmppStunMessage::decode(const QByteArray &buffer, const QString &password, QStringList *errors)
{
@@ -660,6 +661,8 @@ QByteArray QXmppStunMessage::encode(const QString &password, bool addFingerprint
/// type, otherwise returns 0.
///
/// \param buffer
+/// \param cookie
+/// \param id
quint16 QXmppStunMessage::peekType(const QByteArray &buffer, quint32 &cookie, QByteArray &id)
{