From b98f8fc824409a4ae8fa79e32b1a6c0da21501b2 Mon Sep 17 00:00:00 2001
From: Andrew <117602754+Andrew1Hawes@users.noreply.github.com>
Date: Wed, 18 Oct 2023 00:08:39 +0100
Subject: [PATCH] procui: Fix ProcUIInForeground and ProcUIIsRunning comments
 (#330)

* procui: Fix ProcUIInForeground and ProcUIIsRunning comments

* Apply suggestions from code review

Co-authored-by: GaryOderNichts <12049776+GaryOderNichts@users.noreply.github.com>

---------

Co-authored-by: GaryOderNichts <12049776+GaryOderNichts@users.noreply.github.com>
---
 include/proc_ui/procui.h | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/include/proc_ui/procui.h b/include/proc_ui/procui.h
index af5f83ba9..941159892 100644
--- a/include/proc_ui/procui.h
+++ b/include/proc_ui/procui.h
@@ -127,10 +127,11 @@ ProcUIDrawDoneRelease();
  * Determines whether the application is in the foreground.
  *
  * \returns
- * \c true if the application status is #PROCUI_STATUS_IN_FOREGROUND.
+ * \c true if the application is in foreground (e.g. during #PROCUI_STATUS_IN_FOREGROUND or #PROCUI_STATUS_RELEASE_FOREGROUND).
  *
  * \sa
  * - #PROCUI_STATUS_IN_FOREGROUND
+ * - #PROCUI_STATUS_RELEASE_FOREGROUND
  * - ProcUIRegisterCallback()
  */
 BOOL
@@ -185,14 +186,15 @@ ProcUIInitEx(ProcUISaveCallbackEx saveCallback,
              void *arg);
 
 /**
- * Determines whether the application is running.
+ * Determines whether the ProcUI library is running/initialised.
  *
  * \returns
- * \c true if the application is running.
+ * \c true if the ProcUI library is initialised.
  *
- * \if false
- * running? what does that actually mean? any state except exiting?
- * \endif
+ * \sa
+ * - ProcUIInit()
+ * - ProcUIInitEx()
+ * - ProcUIShutdown()
  */
 BOOL
 ProcUIIsRunning();