From 3dd4267a5842d5b956dd79633fa2c8b81fb80d53 Mon Sep 17 00:00:00 2001
From: Linus Jahn <lnj@kaidan.im>
Date: Wed, 28 Dec 2022 21:57:11 +0100
Subject: Configuration: Minor documentation improvements

---
 src/client/QXmppConfiguration.cpp | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

(limited to 'src')

diff --git a/src/client/QXmppConfiguration.cpp b/src/client/QXmppConfiguration.cpp
index a5ee0cd2..0a56a521 100644
--- a/src/client/QXmppConfiguration.cpp
+++ b/src/client/QXmppConfiguration.cpp
@@ -181,72 +181,72 @@ void QXmppConfiguration::setJid(const QString &jid)
     }
 }
 
-/// Returns the host name.
 ///
-/// \return host name
+/// Returns the custom hostname to connect to.
+///
+/// \return hostname
 ///
-
 QString QXmppConfiguration::host() const
 {
     return d->host;
 }
 
-/// Returns the domain name.
+///
+/// Returns the domain part of the JID.
 ///
 /// \return domain name
 ///
-
 QString QXmppConfiguration::domain() const
 {
     return d->domain;
 }
 
+///
 /// Returns the port number.
 ///
 /// \return port number
 ///
-
 int QXmppConfiguration::port() const
 {
     return d->port;
 }
 
-/// Returns the username.
+///
+/// Returns the localpart of the JID.
 ///
 /// \return username
 ///
-
 QString QXmppConfiguration::user() const
 {
     return d->user;
 }
 
+///
 /// Returns the password.
 ///
 /// \return password
 ///
-
 QString QXmppConfiguration::password() const
 {
     return d->password;
 }
 
+///
 /// Returns the resource identifier.
 ///
 /// \return resource identifier
 ///
-
 QString QXmppConfiguration::resource() const
 {
     return d->resource;
 }
 
-/// Returns the jabber id (jid).
 ///
-/// \return jabber id (jid)
+/// Returns the Jabber-ID (JID).
+///
+/// \return Jabber-ID (JID)
 /// (e.g. "qxmpp.test1@gmail.com/resource" or qxmpptest@jabber.org/QXmpp156)
 ///
-
 QString QXmppConfiguration::jid() const
 {
     if (d->user.isEmpty()) {
-- 
cgit v1.2.3