From 28a2e85eae9d4c2d71f05d4bf08bb32e41e60a34 Mon Sep 17 00:00:00 2001 From: Maschell Date: Sat, 30 Jun 2018 19:41:33 +0200 Subject: [PATCH] Add documentation of the WUPS_InitFS and WUPS_InitOverlay function --- wups_include/wups/utils.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/wups_include/wups/utils.h b/wups_include/wups/utils.h index 2cd90df..b56b0ea 100644 --- a/wups_include/wups/utils.h +++ b/wups_include/wups/utils.h @@ -80,7 +80,18 @@ typedef struct wups_loader_init_kernel_args_t_ { /* Gets called by the framework */ +/** + Sets the pointer for wrapping the fs functions. + If NULL pointers are provided, the original function will be called. + The whole point of replacing the fs functions is to inherit SD/USB access. + The argument of the ON_APPLICATION_START hook provides information on the state of SD or USB access. +**/ void WUPS_InitFS(wups_loader_init_fs_args_t args); + +/** + Sets the function pointer for opening the overlay. + If none or a NULL pointer is provided, calling "WUPS_OpenOverlay" has no effect. +**/ void WUPS_InitOverlay(wups_loader_init_overlay_args_t args); /**