Mirrors/unleashed-firmware
2
0
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware synced 2024-11-23 13:03:13 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix logical error in documentation

Browse source
This commit is contained in:
Georgii Surkov 2024-03-13 12:28:08 +03:00
parent 75432346de
commit 2aa85347ee
No known key found for this signature in database
GPG key ID: 44A24455F6ADB5E7
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
applications/main/infrared/infrared_app_i.h
View file

@ -214,8 +214,8 @@ void infrared_tx_stop(InfraredApp* infrared);
/** /**
* @brief Start a blocking task in a separate thread. * @brief Start a blocking task in a separate thread.
* *
* If a ViewStack is currently on screen, a busy "Hourglass" animation * Before starting a blocking task, the current view will be replaced
* will be shown and no input will be accepted until completion. * with a busy animation. All subsequent user input will be ignored.
* *
* @param[in,out] infrared pointer to the application instance. * @param[in,out] infrared pointer to the application instance.
* @param[in] callback pointer to the function to be run in the thread. * @param[in] callback pointer to the function to be run in the thread.
@ -223,10 +223,11 @@ void infrared_tx_stop(InfraredApp* infrared);
void infrared_blocking_task_start(InfraredApp* infrared, FuriThreadCallback callback); void infrared_blocking_task_start(InfraredApp* infrared, FuriThreadCallback callback);
/** /**
* @brief Wait for a blocking task to finish and receive the result. * @brief Wait for a blocking task to finish and get the result.
* *
* Upon the completion of a blocking task, the busy animation will be hidden * The busy animation shown during the infrared_blocking_task_start() call
* and input will be accepted again. * will NOT be hidden and WILL remain on screen. If another view is needed
* (e.g. to display the results), the caller code MUST set it explicitly.
* *
* @param[in,out] infrared pointer to the application instance. * @param[in,out] infrared pointer to the application instance.
* @return true if the blocking task finished successfully, false otherwise. * @return true if the blocking task finished successfully, false otherwise.