aboutsummaryrefslogtreecommitdiff
path: root/src/base
diff options
context:
space:
mode:
authorLinus Jahn <lnj@kaidan.im>2021-08-01 16:58:10 +0200
committerLinus Jahn <lnj@kaidan.im>2021-08-01 16:58:41 +0200
commit6766329e35adb6803d8dc1bb92e0b6d243dad466 (patch)
tree2de4aca86d46ed15f5e803c7dc9346e394344161 /src/base
parent68bcfe6531bec574f31a07a31cd385c8f77ac756 (diff)
downloadqxmpp-6766329e35adb6803d8dc1bb92e0b6d243dad466.tar.gz
Document QXmppVersion()
Diffstat (limited to 'src/base')
-rw-r--r--src/base/QXmppGlobal.h.in5
1 files changed, 4 insertions, 1 deletions
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@");