From 1571d7b43228a0ed4347f681a16b2b23defccda9 Mon Sep 17 00:00:00 2001
From: Sine Striker <trueful@163.com>
Date: 周三, 27 12月 2023 03:52:03 +0800
Subject: [PATCH] Add doxygen documentations
---
src/core/style/styleagent.cpp | 36 +++++++++++++++++++++++++++++++-----
1 files changed, 31 insertions(+), 5 deletions(-)
diff --git a/src/core/style/styleagent.cpp b/src/core/style/styleagent.cpp
index 6c0e740..11d1adc 100644
--- a/src/core/style/styleagent.cpp
+++ b/src/core/style/styleagent.cpp
@@ -5,10 +5,21 @@
namespace QWK {
+ /*!
+ \class StyleAgent
+ \brief StyleAgent provides some features related to system theme.
+ */
+
StyleAgentPrivate::StyleAgentPrivate() {
}
- StyleAgentPrivate::~StyleAgentPrivate() = default;
+ StyleAgentPrivate::~StyleAgentPrivate() {
+ removeSystemThemeHook();
+ }
+
+ void StyleAgentPrivate::init() {
+ setupSystemThemeHook();
+ }
void StyleAgentPrivate::notifyThemeChanged(StyleAgent::SystemTheme theme) {
if (theme == systemTheme)
@@ -19,25 +30,40 @@
Q_EMIT q->systemThemeChanged();
}
+ /*!
+ Constructor. Since it is not related to a concrete window instance, it is better to be used
+ as a singleton.
+ */
StyleAgent::StyleAgent(QObject *parent) : StyleAgent(*new StyleAgentPrivate(), parent) {
- Q_D(StyleAgent);
- d->setupSystemThemeHook();
}
+ /*!
+ Destructor.
+ */
StyleAgent::~StyleAgent() {
- Q_D(StyleAgent);
- d->removeSystemThemeHook();
}
+ /*!
+ Returns the system theme.
+ */
StyleAgent::SystemTheme StyleAgent::systemTheme() const {
Q_D(const StyleAgent);
return d->systemTheme;
}
+ /*!
+ \internal
+ */
StyleAgent::StyleAgent(StyleAgentPrivate &d, QObject *parent) : QObject(parent), d_ptr(&d) {
d.q_ptr = this;
d.init();
}
+ /*!
+ \fn void StyleAgent::systemThemeChanged()
+
+ This signal is emitted when the system theme changes.
+ */
+
}
--
Gitblit v1.9.1