From c06bb37630a3ca79dc1992ab25cf65455c261978 Mon Sep 17 00:00:00 2001
From: Sine Striker <trueful@163.com>
Date: 周一, 06 5月 2024 19:30:56 +0800
Subject: [PATCH] Update metadata

---
 CMakeLists.txt |   25 +++++++++++++++++++++++++
 1 files changed, 25 insertions(+), 0 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 0703977..ea1881c 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -16,6 +16,31 @@
 option(QWINDOWKIT_ENABLE_WINDOWS_SYSTEM_BORDERS "Enable system borders on Windows" ON)
 option(QWINDOWKIT_ENABLE_STYLE_AGENT "Enable building style agent" ON)
 
+#[[
+
+Detailed Introcuction to Congigure Options:
+
+`QWINDOWKIT_BUILD_DOCUMENTATIONS`
+  - If you have installed `Doxygen`, you can ENABLE this option so that the documentations
+    will also be built and installed.
+  - If not, you can read the comments in `qdoc` style in `cpp` files to get detailed usages
+    of the public APIs.
+
+`QWINDOWKIT_ENABLE_WINDOWS_SYSTEM_BORDERS`
+  - If you don't want the system borders on Windows 10/11, you can DISABLE this option.
+  - If so, the Windows 10 top border issue will disappear. However, part of the client edge
+    area will be occupied as the resizing margins.
+
+`QWINDOWKIT_ENABLE_QT_WINDOW_CONTEXT`
+  - If you want to use pure Qt emulated frameless implementation, you can ENABLE this option.
+  - If so, all system native features will be lost.
+
+`QWINDOWKIT_ENABLE_STYLE_AGENT`
+  - Select whether to exclude the style component by DISABLING this option according to your
+    requirements and your Qt version.
+
+#]]
+
 # ----------------------------------
 # CMake Settings
 # ----------------------------------

--
Gitblit v1.9.1