Document that availability of slint::testing is conditional to enabli…

…ng the feature and experimental features.
task-jp · Jul 11, 2024 · bda89c2 · bda89c2
1 parent 2be4b32
commit bda89c2
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/api/cpp/include/slint-testing.h b/api/cpp/include/slint-testing.h
@@ -10,6 +10,11 @@
 #ifdef SLINT_FEATURE_TESTING
 #    ifdef SLINT_FEATURE_EXPERIMENTAL
 
+/// Use the functions and classes in this namespace for in-process UI testing.
+///
+/// This module is still experimental - it's API is subject to changes and not stabilized yet. To
+/// use the module, you must enable the `SLINT_FEATURE_EXPERIMENTAL=ON` and `SLINT_FEATURE_TESTING`
+/// CMake options.
 namespace slint::testing {
 
 using slint::cbindgen_private::AccessibleRole;