From 11fadf1e8bf274d219d66e552cd8c73d0bad34dd Mon Sep 17 00:00:00 2001 From: Maschell Date: Sat, 18 Feb 2023 09:13:27 +0100 Subject: [PATCH] Add API requirement to function declarations --- include/rpxloader/rpxloader.h | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/include/rpxloader/rpxloader.h b/include/rpxloader/rpxloader.h index cc9e1ab..de8d7b0 100644 --- a/include/rpxloader/rpxloader.h +++ b/include/rpxloader/rpxloader.h @@ -59,6 +59,8 @@ RPXLoaderStatus RPXLoader_GetVersion(uint32_t *outVersion); * The path is **relative** to the root of the given target device.
*
* To launch the prepared RPX call RPXLoader_LaunchPreparedHomebrew if this call was successful.
+ *
+ * Requires API version 1 or higher.
* * @param path: path to the .rpx/.wuhb that should be loaded. * @return RPX_LOADER_RESULT_SUCCESS: Loading of the next RPX will be redirected.
@@ -74,6 +76,8 @@ RPXLoaderStatus RPXLoader_PrepareLaunchFromSD(const char *path); * Works similar similar to the SYSLaunch* functions.
*
* see: `RPXLoader_LaunchHomebrew` to prepare and launch a RPX in one command.
+ *
+ * Requires API version 1 or higher.
* * @return RPX_LOADER_RESULT_SUCCESS: App is launching
* RPX_LOADER_RESULT_LIB_UNINITIALIZED: Library was not initialized. Call RPX_LOADER_InitLibrary() before using this function.
@@ -87,7 +91,10 @@ RPXLoaderStatus RPXLoader_LaunchPreparedHomebrew(); * Launches a given .rpx/.wuhb by launching a wrapper application and replacing the RPX on the fly.
* See RPXLoader_PrepareLaunchFromSD for more information.
*
- * Note: Combines RPXLoader_PrepareLaunchFromSD and RPXLoader_LaunchPreparedHomebrew. + * Note: Combines RPXLoader_PrepareLaunchFromSD and RPXLoader_LaunchPreparedHomebrew.
+ *
+ * Requires API version 1 or higher.
+ * * @param bundle_path path to the .rpx/.wuhb that should be loaded. * @return RPX_LOADER_RESULT_SUCCESS: Requested RPX/WUHB will be launched
* RPX_LOADER_RESULT_LIB_UNINITIALIZED: Library was not initialized. Call RPXLoader_InitLibrary() before using this function.
@@ -99,7 +106,9 @@ RPXLoaderStatus RPXLoader_LaunchPreparedHomebrew(); RPXLoaderStatus RPXLoader_LaunchHomebrew(const char *bundle_path); /** - * Enables the /vol/content redirection (is enabled by default if a .wuhb is running) + * Enables the /vol/content redirection (is enabled by default if a .wuhb is running)
+ *
+ * Requires API version 1 or higher.
* * @return RPX_LOADER_RESULT_SUCCESS: /vol/content has been enabled or was already enabled.
* RPX_LOADER_RESULT_LIB_UNINITIALIZED: "RPXLoader_Init()" was not called.
@@ -108,7 +117,9 @@ RPXLoaderStatus RPXLoader_LaunchHomebrew(const char *bundle_path); RPXLoaderStatus RPXLoader_EnableContentRedirection(); /** - * Disables the /vol/content redirection + * Disables the /vol/content redirection
+ *
+ * Requires API version 1 or higher.
* * @return RPX_LOADER_RESULT_SUCCESS: /vol/content has been disabled or was already disabled.
* RPX_LOADER_RESULT_LIB_UNINITIALIZED: "RPXLoader_Init()" was not called.
@@ -117,7 +128,9 @@ RPXLoaderStatus RPXLoader_EnableContentRedirection(); RPXLoaderStatus RPXLoader_DisableContentRedirection(); /** - * Unmounts the currently running bundle. This also disables the /vol/content redirection + * Unmounts the currently running bundle. This also disables the /vol/content redirection
+ *
+ * Requires API version 1 or higher.
* * @return RPX_LOADER_RESULT_SUCCESS: /vol/content has been unmounted or was not previously mounted.
* RPX_LOADER_RESULT_LIB_UNINITIALIZED: "RPXLoader_Init()" was not called.