procui: Fix ProcUIInForeground and ProcUIIsRunning comments (#330)

* procui: Fix ProcUIInForeground and ProcUIIsRunning comments * Apply suggestions from code review Co-authored-by: GaryOderNichts <[email protected]> --------- Co-authored-by: GaryOderNichts <[email protected]>
devkitPro · Oct 17, 2023 · b98f8fc · b98f8fc
1 parent 922eb45
commit b98f8fc
Showing 1 changed file with 8 additions and 6 deletions.
diff --git 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();