From 6766329e35adb6803d8dc1bb92e0b6d243dad466 Mon Sep 17 00:00:00 2001
From: Linus Jahn <lnj@kaidan.im>
Date: Sun, 1 Aug 2021 16:58:10 +0200
Subject: Document QXmppVersion()

---
 src/base/QXmppGlobal.h.in | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'src/base')

diff --git a/src/base/QXmppGlobal.h.in b/src/base/QXmppGlobal.h.in
index 2e1a6be6..78b11fec 100644
--- a/src/base/QXmppGlobal.h.in
+++ b/src/base/QXmppGlobal.h.in
@@ -42,6 +42,7 @@
 
 #define QXMPP_AUTOTEST_EXPORT
 
+///
 /// This macro expands a numeric value of the form 0xMMNNPP (MM =
 /// major, NN = minor, PP = patch) that specifies QXmpp's version
 /// number. For example, if you compile your application against
@@ -50,9 +51,11 @@
 /// You can use QXMPP_VERSION to use the latest QXmpp features where
 /// available.
 ///
-
 #define QXMPP_VERSION QT_VERSION_CHECK(@PROJECT_VERSION_MAJOR@, @PROJECT_VERSION_MINOR@, @PROJECT_VERSION_PATCH@)
 
+///
+/// Returns the version of QXmpp used at compile time as a string.
+///
 inline QLatin1String QXmppVersion()
 {
     return QLatin1String("@PROJECT_VERSION@");
-- 
cgit v1.2.3