aboutsummaryrefslogtreecommitdiff
path: root/src/base
diff options
context:
space:
mode:
authorLinus Jahn <lnj@kaidan.im>2022-08-31 16:41:46 +0200
committerLinus Jahn <lnj@kaidan.im>2022-08-31 16:52:12 +0200
commit54e3c950100319382c79d06357647255cb196ca0 (patch)
tree399bbb0fe062055853ced2b70ecfa864a2104b51 /src/base
parent70f185a6cd0826509d818bff6d765030a32a8943 (diff)
downloadqxmpp-54e3c950100319382c79d06357647255cb196ca0.tar.gz
BobContentId: Move and update documentation about supported algorithmns
Diffstat (limited to 'src/base')
-rw-r--r--src/base/QXmppBitsOfBinaryContentId.cpp14
1 files changed, 8 insertions, 6 deletions
diff --git a/src/base/QXmppBitsOfBinaryContentId.cpp b/src/base/QXmppBitsOfBinaryContentId.cpp
index f47dcc26..4a599c2d 100644
--- a/src/base/QXmppBitsOfBinaryContentId.cpp
+++ b/src/base/QXmppBitsOfBinaryContentId.cpp
@@ -52,6 +52,14 @@ QXmppBitsOfBinaryContentIdPrivate::QXmppBitsOfBinaryContentIdPrivate()
/// QXmppBitsOfBinaryContentId represents a link to or an identifier of
/// \xep{0231, Bits of Binary} data.
///
+/// Currently supported hash algorithms:
+/// * MD4
+/// * MD5
+/// * SHA-1
+/// * SHA-2 (SHA-224, SHA-256, SHA-384, SHA-512)
+/// * SHA-3 (SHA3-224, SHA3-256, SHA3-384, SHA3-512)
+/// * BLAKE2 (BLAKE2b256, BLAKE2b512) (requires Qt 6, since QXmpp 1.5)
+///
/// \since QXmpp 1.2
///
@@ -180,9 +188,6 @@ void QXmppBitsOfBinaryContentId::setHash(const QByteArray &hash)
///
/// The default value is \c QCryptographicHash::Sha1.
///
-/// This currently supports MD4, MD5, SHA-1, SHA-2 (SHA224 - SHA512) and SHA-3
-/// (SHA3-224 - SHA3-512).
-///
QCryptographicHash::Algorithm QXmppBitsOfBinaryContentId::algorithm() const
{
return d->algorithm;
@@ -193,9 +198,6 @@ QCryptographicHash::Algorithm QXmppBitsOfBinaryContentId::algorithm() const
///
/// The default value is \c QCryptographicHash::Sha1.
///
-/// This currently supports MD4, MD5, SHA-1, SHA-2 (SHA224 - SHA512) and SHA-3
-/// (SHA3-224 - SHA3-512).
-///
/// \note Only change this, if you know what you do. The XEP allows other
/// hashing algorithms than SHA-1 to be used, but not all clients support this.
/// Since in most cases the content id is not security relevant it is not a