aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorLinus Jahn <lnj@kaidan.im>2020-04-06 17:20:11 +0200
committerLinus Jahn <lnj@kaidan.im>2020-04-06 17:20:11 +0200
commitd7265e11c4bdab3b203362cf3052834d7371d507 (patch)
tree1285acb9ccc678b805f2f8043c7ee9d5fa11f4c3 /src
parent8be8ee308c5523a207ea1aac9a0174ab0c42e0f7 (diff)
downloadqxmpp-d7265e11c4bdab3b203362cf3052834d7371d507.tar.gz
Add \since tags for QXmpp 0.9 everywhere
Diffstat (limited to 'src')
-rw-r--r--src/base/QXmppJingleIq.cpp62
-rw-r--r--src/server/QXmppServer.cpp10
2 files changed, 60 insertions, 12 deletions
diff --git a/src/base/QXmppJingleIq.cpp b/src/base/QXmppJingleIq.cpp
index 8af05ab4..64650d29 100644
--- a/src/base/QXmppJingleIq.cpp
+++ b/src/base/QXmppJingleIq.cpp
@@ -235,11 +235,23 @@ void QXmppJingleIq::Content::setDescriptionMedia(const QString &media)
d->descriptionMedia = media;
}
+///
+/// Returns the description's 32-bit synchronization source for the media
+/// stream, as defined in RFC 3550.
+///
+/// \since QXmpp 0.9
+///
quint32 QXmppJingleIq::Content::descriptionSsrc() const
{
return d->descriptionSsrc;
}
+///
+/// Sets the description's 32-bit synchronization source for the media stream,
+/// as defined in RFC 3550.
+///
+/// \since QXmpp 0.9
+///
void QXmppJingleIq::Content::setDescriptionSsrc(quint32 ssrc)
{
d->descriptionSsrc = ssrc;
@@ -304,55 +316,73 @@ void QXmppJingleIq::Content::setTransportPassword(const QString &password)
d->transportPassword = password;
}
+///
/// Returns the fingerprint hash value for the transport key.
///
/// This is used for DTLS-SRTP as defined in \xep{0320}.
-
+///
+/// \since QXmpp 0.9
+///
QByteArray QXmppJingleIq::Content::transportFingerprint() const
{
return d->transportFingerprint;
}
+///
/// Sets the fingerprint hash value for the transport key.
///
/// This is used for DTLS-SRTP as defined in \xep{0320}.
-
+///
+/// \since QXmpp 0.9
+///
void QXmppJingleIq::Content::setTransportFingerprint(const QByteArray &fingerprint)
{
d->transportFingerprint = fingerprint;
}
+///
/// Returns the fingerprint hash algorithm for the transport key.
///
/// This is used for DTLS-SRTP as defined in \xep{0320}.
-
+///
+/// \since QXmpp 0.9
+///
QString QXmppJingleIq::Content::transportFingerprintHash() const
{
return d->transportFingerprintHash;
}
+///
/// Sets the fingerprint hash algorithm for the transport key.
///
/// This is used for DTLS-SRTP as defined in \xep{0320}.
-
+///
+/// \since QXmpp 0.9
+///
void QXmppJingleIq::Content::setTransportFingerprintHash(const QString &hash)
{
d->transportFingerprintHash = hash;
}
+///
/// Returns the setup role for the encrypted transport.
///
/// This is used for DTLS-SRTP as defined in \xep{0320}.
-
+///
+/// \since QXmpp 0.9
+///
QString QXmppJingleIq::Content::transportFingerprintSetup() const
{
return d->transportFingerprintSetup;
}
+///
/// Sets the setup role for the encrypted transport.
///
/// This is used for DTLS-SRTP as defined in \xep{0320}.
-
+///
+/// \since QXmpp 0.9
+///
void QXmppJingleIq::Content::setTransportFingerprintSetup(const QString &setup)
{
d->transportFingerprintSetup = setup;
@@ -985,33 +1015,45 @@ void QXmppJingleCandidate::setComponent(int component)
d->component = component;
}
+///
/// Returns the candidate's foundation.
-
+///
+/// \since QXmpp 0.9
+///
QString QXmppJingleCandidate::foundation() const
{
return d->foundation;
}
+///
/// Sets the candidate's foundation.
///
/// \param foundation
-
+///
+/// \since QXmpp 0.9
+///
void QXmppJingleCandidate::setFoundation(const QString &foundation)
{
d->foundation = foundation;
}
+///
/// Returns the candidate's generation.
-
+///
+/// \since QXmpp 0.9
+///
int QXmppJingleCandidate::generation() const
{
return d->generation;
}
+///
/// Sets the candidate's generation.
///
/// \param generation
-
+///
+/// \since QXmpp 0.9
+///
void QXmppJingleCandidate::setGeneration(int generation)
{
d->generation = generation;
diff --git a/src/server/QXmppServer.cpp b/src/server/QXmppServer.cpp
index da018389..4591fc3e 100644
--- a/src/server/QXmppServer.cpp
+++ b/src/server/QXmppServer.cpp
@@ -472,10 +472,13 @@ void QXmppServer::setLocalCertificate(const QString &path)
server->setLocalCertificate(d->localCertificate);
}
+///
/// Sets the local SSL certificate
///
/// \param certificate
-
+///
+/// \since QXmpp 0.9
+///
void QXmppServer::setLocalCertificate(const QSslCertificate &certificate)
{
d->localCertificate = certificate;
@@ -508,10 +511,13 @@ void QXmppServer::setPrivateKey(const QString &path)
server->setPrivateKey(d->privateKey);
}
+///
/// Sets the local SSL private key.
///
/// \param key
-
+///
+/// \since QXmpp 0.9
+///
void QXmppServer::setPrivateKey(const QSslKey &key)
{
d->privateKey = key;