Leahnaya/wut
1
0
Fork 0
mirror of https://github.com/devkitPro/wut.git synced 2026-08-27 13:25:19 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

procui: Fix ProcUIInForeground and ProcUIIsRunning comments (#330)

Browse Source 
* 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>
This commit is contained in:
Andrew
2023-10-18 00:08:39 +01:00
committed by GitHub
parent 922eb4583e
commit b98f8fc824
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
include/proc_ui/procui.h
View File

@@ -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();