aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2012-07-21 19:07:07 +0200
committerJeremy Lainé <jeremy.laine@m4x.org>2012-07-21 19:07:07 +0200
commita5d571e80fbabfe78b23c914493d6397bd966efd (patch)
tree000ad6ad3852022b7c4a7da5366f2b2010a4846e /src
parent0140c7a78fe28606fe71aeebf262709407051309 (diff)
downloadqxmpp-a5d571e80fbabfe78b23c914493d6397bd966efd.tar.gz
doc fixes
Diffstat (limited to 'src')
-rw-r--r--src/base/QXmppLogger.cpp2
-rw-r--r--src/base/QXmppMucIq.cpp4
-rw-r--r--src/client/QXmppConfiguration.cpp3
-rw-r--r--src/server/QXmppServer.cpp5
-rw-r--r--src/server/QXmppServer.h4
5 files changed, 11 insertions, 7 deletions
diff --git a/src/base/QXmppLogger.cpp b/src/base/QXmppLogger.cpp
index b56b154a..def06292 100644
--- a/src/base/QXmppLogger.cpp
+++ b/src/base/QXmppLogger.cpp
@@ -74,6 +74,7 @@ QXmppLoggable::QXmppLoggable(QObject *parent)
}
}
+/// \cond
void QXmppLoggable::childEvent(QChildEvent *event)
{
QXmppLoggable *child = qobject_cast<QXmppLoggable*>(event->child());
@@ -88,6 +89,7 @@ void QXmppLoggable::childEvent(QChildEvent *event)
this, SIGNAL(logMessage(QXmppLogger::MessageType,QString)));
}
}
+/// \endcond
class QXmppLoggerPrivate
{
diff --git a/src/base/QXmppMucIq.cpp b/src/base/QXmppMucIq.cpp
index 986ce567..deaa33b0 100644
--- a/src/base/QXmppMucIq.cpp
+++ b/src/base/QXmppMucIq.cpp
@@ -68,6 +68,7 @@ QXmppMucItem::Affiliation QXmppMucItem::affiliation() const
return m_affiliation;
}
+/// \cond
QXmppMucItem::Affiliation QXmppMucItem::affiliationFromString(const QString &affiliationStr)
{
if (affiliationStr == "owner")
@@ -101,6 +102,7 @@ QString QXmppMucItem::affiliationToString(Affiliation affiliation)
return QString();
}
}
+/// \endcond
/// Sets the user's affiliation, i.e. long-lived permissions.
///
@@ -166,6 +168,7 @@ QXmppMucItem::Role QXmppMucItem::role() const
return m_role;
}
+/// \cond
QXmppMucItem::Role QXmppMucItem::roleFromString(const QString &roleStr)
{
if (roleStr == "moderator")
@@ -195,6 +198,7 @@ QString QXmppMucItem::roleToString(Role role)
return QString();
}
}
+/// \endcond
/// Sets the user's role, i.e. short-lived permissions.
///
diff --git a/src/client/QXmppConfiguration.cpp b/src/client/QXmppConfiguration.cpp
index 62fa7a07..336630ee 100644
--- a/src/client/QXmppConfiguration.cpp
+++ b/src/client/QXmppConfiguration.cpp
@@ -546,6 +546,7 @@ QList<QSslCertificate> QXmppConfiguration::caCertificates() const
// obsolete
+/// \cond
QXmppConfiguration::SASLAuthMechanism QXmppConfiguration::sASLAuthMechanism() const
{
if (d->saslAuthMechanism == "PLAIN")
@@ -578,4 +579,4 @@ void QXmppConfiguration::setSASLAuthMechanism(
break;
}
}
-
+/// \endcond
diff --git a/src/server/QXmppServer.cpp b/src/server/QXmppServer.cpp
index aeb0f644..b329053d 100644
--- a/src/server/QXmppServer.cpp
+++ b/src/server/QXmppServer.cpp
@@ -574,9 +574,10 @@ bool QXmppServer::sendPacket(const QXmppStanza &packet)
return d->routeData(packet.to(), data);
}
-/// Add a new incoming client stream.
+/// Add a new incoming client \a stream.
///
-/// \param stream
+/// This method can be used for instance to implement BOSH support
+/// as a server extension.
void QXmppServer::addIncomingClient(QXmppIncomingClient *stream)
{
diff --git a/src/server/QXmppServer.h b/src/server/QXmppServer.h
index 2e905f41..7f546d52 100644
--- a/src/server/QXmppServer.h
+++ b/src/server/QXmppServer.h
@@ -89,11 +89,7 @@ public:
bool sendElement(const QDomElement &element);
bool sendPacket(const QXmppStanza &stanza);
- /// \cond
- // FIXME: this method should not be public, but it is needed to
- // implement BOSH support as an extension.
void addIncomingClient(QXmppIncomingClient *stream);
- /// \endcond
signals:
/// This signal is emitted when a client has connected.