Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

procui: Fix ProcUIInForeground and ProcUIIsRunning comments #330

Merged
merged 2 commits into from
Oct 17, 2023
Merged

procui: Fix ProcUIInForeground and ProcUIIsRunning comments #330

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e533b98
procui: Fix ProcUIInForeground and ProcUIIsRunning comments
Andrew1Hawes Oct 11, 2023
ed44d93
Apply suggestions from code review
Andrew1Hawes Oct 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions include/proc_ui/procui.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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();
Expand Down