From 8849303e4492acdab9605129d41fffe2b4585c7b Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Thu, 10 May 2012 10:10:29 +0200
Subject: fix some documentation warnings

---
 src/base/QXmppUtils.cpp | 31 ++++++++++++++++++++++++-------
 1 file changed, 24 insertions(+), 7 deletions(-)

(limited to 'src/base/QXmppUtils.cpp')

diff --git a/src/base/QXmppUtils.cpp b/src/base/QXmppUtils.cpp
index f308710c..97ce8e1e 100644
--- a/src/base/QXmppUtils.cpp
+++ b/src/base/QXmppUtils.cpp
@@ -107,6 +107,9 @@ static quint32 crctable[256] =
     0xB40BBE37L, 0xC30C8EA1L, 0x5A05DF1BL, 0x2D02EF8DL
 };
 
+/// Parses a date-time from a string according to
+/// XEP-0082: XMPP Date and Time Profiles.
+
 QDateTime QXmppUtils::datetimeFromString(const QString &str)
 {
     QRegExp tzRe("(Z|([+-])([0-9]{2}):([0-9]{2}))");
@@ -137,6 +140,9 @@ QDateTime QXmppUtils::datetimeFromString(const QString &str)
     return dt;
 }
 
+/// Serializes a date-time to a string according to
+/// XEP-0082: XMPP Date and Time Profiles.
+
 QString QXmppUtils::datetimeToString(const QDateTime &dt)
 {
     QDateTime utc = dt.toUTC();
@@ -146,10 +152,8 @@ QString QXmppUtils::datetimeToString(const QDateTime &dt)
         return utc.toString("yyyy-MM-ddThh:mm:ssZ");
 }
 
-/// Parses a timezone offset (in seconds) from a string.
-///
-/// \param str
-///
+/// Parses a timezone offset (in seconds) from a string according to
+/// XEP-0082: XMPP Date and Time Profiles.
 
 int QXmppUtils::timezoneOffsetFromString(const QString &str)
 {
@@ -170,9 +174,8 @@ int QXmppUtils::timezoneOffsetFromString(const QString &str)
         return offset;
 }
 
-/// Serializes a timezone offset (in seconds) to a string.
-///
-/// \param secs
+/// Serializes a timezone offset (in seconds) to a string according to
+/// XEP-0082: XMPP Date and Time Profiles.
 
 QString QXmppUtils::timezoneOffsetToString(int secs)
 {
@@ -183,11 +186,15 @@ QString QXmppUtils::timezoneOffsetToString(int secs)
     return (secs < 0 ? "-" : "+") + tzoTime.toString("hh:mm");
 }
 
+/// Returns the domain for the given \a jid.
+
 QString QXmppUtils::jidToDomain(const QString &jid)
 {
     return jidToBareJid(jid).split("@").last();
 }
 
+/// Returns the resource for the given \a jid.
+
 QString QXmppUtils::jidToResource(const QString& jid)
 {
     const int pos = jid.indexOf(QChar('/'));
@@ -196,6 +203,8 @@ QString QXmppUtils::jidToResource(const QString& jid)
     return jid.mid(pos+1);
 }
 
+/// Returns the user for the given \a jid.
+
 QString QXmppUtils::jidToUser(const QString &jid)
 {
     const int pos = jid.indexOf(QChar('@'));
@@ -204,6 +213,8 @@ QString QXmppUtils::jidToUser(const QString &jid)
     return jid.left(pos);
 }
 
+/// Returns the bare jid (i.e. without resource) for the given \a jid.
+
 QString QXmppUtils::jidToBareJid(const QString& jid)
 {
     const int pos = jid.indexOf(QChar('/'));
@@ -212,6 +223,8 @@ QString QXmppUtils::jidToBareJid(const QString& jid)
     return jid.left(pos);
 }
 
+/// Calculates the CRC32 checksum for the given input.
+
 quint32 QXmppUtils::generateCrc32(const QByteArray &in)
 {
     quint32 result = 0xffffffff;
@@ -243,11 +256,15 @@ static QByteArray generateHmac(QCryptographicHash::Algorithm algorithm, const QB
     return hasher.result();
 }
 
+/// Generates the MD5 HMAC for the given \a key and \a text.
+
 QByteArray QXmppUtils::generateHmacMd5(const QByteArray &key, const QByteArray &text)
 {
     return generateHmac(QCryptographicHash::Md5, key, text);
 }
 
+/// Generates the SHA1 HMAC for the given \a key and \a text.
+
 QByteArray QXmppUtils::generateHmacSha1(const QByteArray &key, const QByteArray &text)
 {
     return generateHmac(QCryptographicHash::Sha1, key, text);
-- 
cgit v1.2.3