From c124e837c589668e18054ae5c609ef5f77b4042f Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@qt.io>
Date: Wed, 24 May 2023 09:36:35 +0200
Subject: [PATCH] Doc: Add docs for Utils::Environment::systemEnvironment()

Because we link to it from the Utils namespace docs.

Change-Id: I4d320b34687e7a6304cbedcbf7e2e5d3a43642b6
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
---
 src/libs/utils/environment.cpp | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/libs/utils/environment.cpp b/src/libs/utils/environment.cpp
index 977e63adb06..a65a48aa679 100644
--- a/src/libs/utils/environment.cpp
+++ b/src/libs/utils/environment.cpp
@@ -12,6 +12,13 @@
 #include <QReadWriteLock>
 #include <QSet>
 
+/*!
+    \class Utils::Environment
+    \inmodule QtCreator
+
+    \brief The Environment class sets \QC's system environment.
+*/
+
 namespace Utils {
 
 static QReadWriteLock s_envMutex;
@@ -184,6 +191,14 @@ void Environment::prependOrSetLibrarySearchPaths(const FilePaths &values)
     });
 }
 
+/*!
+    Returns \QC's system environment.
+
+    This can be different from the system environment that \QC started in if the
+    user changed it in \uicontrol Preferences > \uicontrol Environment >
+    \uicontrol System > \uicontrol Environment.
+*/
+
 Environment Environment::systemEnvironment()
 {
     QReadLocker lock(&s_envMutex);